EditableAPI
Defined in: packages/editor/src/types/editor.ts:41
Properties
Section titled “Properties”activeAnnotations()
Section titled “activeAnnotations()”activeAnnotations: () =>
PortableTextObject[]
Defined in: packages/editor/src/types/editor.ts:42
Returns
Section titled “Returns”addAnnotation()
Section titled “addAnnotation()”addAnnotation: <
TSchemaType>(type,value?) =>undefined| {markDefPath:Path;markDefPaths:Path[];spanPath:Path; }
Defined in: packages/editor/src/types/editor.ts:44
Type Parameters
Section titled “Type Parameters”TSchemaType
Section titled “TSchemaType”TSchemaType extends object
Parameters
Section titled “Parameters”TSchemaType
value?
Section titled “value?”Returns
Section titled “Returns”undefined | { markDefPath: Path; markDefPaths: Path[]; spanPath: Path; }
blur()
Section titled “blur()”blur: () =>
void
Defined in: packages/editor/src/types/editor.ts:50
Returns
Section titled “Returns”void
delete()
Section titled “delete()”delete: (
selection,options?) =>void
Defined in: packages/editor/src/types/editor.ts:51
Parameters
Section titled “Parameters”selection
Section titled “selection”options?
Section titled “options?”Returns
Section titled “Returns”void
findByPath()
Section titled “findByPath()”findByPath: (
path) => [undefined|PortableTextSpan|PortableTextObject|PortableTextTextBlock<PortableTextSpan|PortableTextObject>,undefined|Path]
Defined in: packages/editor/src/types/editor.ts:55
Parameters
Section titled “Parameters”Path
Returns
Section titled “Returns”[undefined | PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>, undefined | Path]
findDOMNode()
Section titled “findDOMNode()”findDOMNode: (
element) =>undefined|Node
Defined in: packages/editor/src/types/editor.ts:58
Parameters
Section titled “Parameters”element
Section titled “element”PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>
Returns
Section titled “Returns”undefined | Node
focus()
Section titled “focus()”focus: () =>
void
Defined in: packages/editor/src/types/editor.ts:61
Returns
Section titled “Returns”void
focusBlock()
Section titled “focusBlock()”focusBlock: () =>
undefined|PortableTextBlock
Defined in: packages/editor/src/types/editor.ts:62
Returns
Section titled “Returns”undefined | PortableTextBlock
focusChild()
Section titled “focusChild()”focusChild: () =>
undefined|PortableTextChild
Defined in: packages/editor/src/types/editor.ts:63
Returns
Section titled “Returns”undefined | PortableTextChild
getFragment()
Section titled “getFragment()”getFragment: () =>
undefined|PortableTextBlock[]
Defined in: packages/editor/src/types/editor.ts:65
Returns
Section titled “Returns”undefined | PortableTextBlock[]
getSelection()
Section titled “getSelection()”getSelection: () =>
EditorSelection
Defined in: packages/editor/src/types/editor.ts:64
Returns
Section titled “Returns”getValue()
Section titled “getValue()”getValue: () =>
undefined|PortableTextBlock[]
Defined in: packages/editor/src/types/editor.ts:66
Returns
Section titled “Returns”undefined | PortableTextBlock[]
hasBlockStyle()
Section titled “hasBlockStyle()”hasBlockStyle: (
style) =>boolean
Defined in: packages/editor/src/types/editor.ts:67
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
hasListStyle()
Section titled “hasListStyle()”hasListStyle: (
listStyle) =>boolean
Defined in: packages/editor/src/types/editor.ts:68
Parameters
Section titled “Parameters”listStyle
Section titled “listStyle”string
Returns
Section titled “Returns”boolean
insertBlock()
Section titled “insertBlock()”insertBlock: <
TSchemaType>(type,value?) =>Path
Defined in: packages/editor/src/types/editor.ts:69
Type Parameters
Section titled “Type Parameters”TSchemaType
Section titled “TSchemaType”TSchemaType extends object
Parameters
Section titled “Parameters”TSchemaType
value?
Section titled “value?”Returns
Section titled “Returns”Path
insertBreak()
Section titled “insertBreak()”insertBreak: () =>
void
Defined in: packages/editor/src/types/editor.ts:77
Returns
Section titled “Returns”void
insertChild()
Section titled “insertChild()”insertChild: <
TSchemaType>(type,value?) =>Path
Defined in: packages/editor/src/types/editor.ts:73
Type Parameters
Section titled “Type Parameters”TSchemaType
Section titled “TSchemaType”TSchemaType extends object
Parameters
Section titled “Parameters”TSchemaType
value?
Section titled “value?”Returns
Section titled “Returns”Path
isAnnotationActive()
Section titled “isAnnotationActive()”isAnnotationActive: (
annotationType) =>boolean
Defined in: packages/editor/src/types/editor.ts:43
Parameters
Section titled “Parameters”annotationType
Section titled “annotationType”string
Returns
Section titled “Returns”boolean
isCollapsedSelection()
Section titled “isCollapsedSelection()”isCollapsedSelection: () =>
boolean
Defined in: packages/editor/src/types/editor.ts:78
Returns
Section titled “Returns”boolean
isExpandedSelection()
Section titled “isExpandedSelection()”isExpandedSelection: () =>
boolean
Defined in: packages/editor/src/types/editor.ts:79
Returns
Section titled “Returns”boolean
isMarkActive()
Section titled “isMarkActive()”isMarkActive: (
mark) =>boolean
Defined in: packages/editor/src/types/editor.ts:80
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
isSelectionsOverlapping()
Section titled “isSelectionsOverlapping()”isSelectionsOverlapping: (
selectionA,selectionB) =>boolean
Defined in: packages/editor/src/types/editor.ts:81
Parameters
Section titled “Parameters”selectionA
Section titled “selectionA”selectionB
Section titled “selectionB”Returns
Section titled “Returns”boolean
isVoid()
Section titled “isVoid()”isVoid: (
element) =>boolean
Defined in: packages/editor/src/types/editor.ts:85
Parameters
Section titled “Parameters”element
Section titled “element”PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>
Returns
Section titled “Returns”boolean
marks()
Section titled “marks()”marks: () =>
string[]
Defined in: packages/editor/src/types/editor.ts:86
Returns
Section titled “Returns”string[]
redo()
Section titled “redo()”redo: () =>
void
Defined in: packages/editor/src/types/editor.ts:87
Returns
Section titled “Returns”void
removeAnnotation()
Section titled “removeAnnotation()”removeAnnotation: <
TSchemaType>(type) =>void
Defined in: packages/editor/src/types/editor.ts:88
Type Parameters
Section titled “Type Parameters”TSchemaType
Section titled “TSchemaType”TSchemaType extends object
Parameters
Section titled “Parameters”TSchemaType
Returns
Section titled “Returns”void
select()
Section titled “select()”select: (
selection) =>void
Defined in: packages/editor/src/types/editor.ts:91
Parameters
Section titled “Parameters”selection
Section titled “selection”Returns
Section titled “Returns”void
toggleBlockStyle()
Section titled “toggleBlockStyle()”toggleBlockStyle: (
blockStyle) =>void
Defined in: packages/editor/src/types/editor.ts:92
Parameters
Section titled “Parameters”blockStyle
Section titled “blockStyle”string
Returns
Section titled “Returns”void
toggleList()
Section titled “toggleList()”toggleList: (
listStyle) =>void
Defined in: packages/editor/src/types/editor.ts:93
Parameters
Section titled “Parameters”listStyle
Section titled “listStyle”string
Returns
Section titled “Returns”void
toggleMark()
Section titled “toggleMark()”toggleMark: (
mark) =>void
Defined in: packages/editor/src/types/editor.ts:94
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
undo()
Section titled “undo()”undo: () =>
void
Defined in: packages/editor/src/types/editor.ts:95
Returns
Section titled “Returns”void