EditableAPI
Defined in: packages/editor/src/types/editor.ts:43
Properties
activeAnnotations()
activeAnnotations: () =>
PortableTextObject[]
Defined in: packages/editor/src/types/editor.ts:44
Returns
PortableTextObject[]
addAnnotation()
addAnnotation: <
TSchemaType>(type,value?) =>undefined| {markDefPath:Path;markDefPaths:Path[];spanPath:Path; }
Defined in: packages/editor/src/types/editor.ts:46
Type Parameters
• TSchemaType extends object
Parameters
type
TSchemaType
value?
Returns
undefined | { markDefPath: Path; markDefPaths: Path[]; spanPath: Path; }
blur()
blur: () =>
void
Defined in: packages/editor/src/types/editor.ts:52
Returns
void
delete()
delete: (
selection,options?) =>void
Defined in: packages/editor/src/types/editor.ts:53
Parameters
selection
options?
Returns
void
findByPath()
findByPath: (
path) => [undefined|PortableTextSpan|PortableTextObject|PortableTextTextBlock,undefined|Path]
Defined in: packages/editor/src/types/editor.ts:57
Parameters
path
Path
Returns
[undefined | PortableTextSpan | PortableTextObject | PortableTextTextBlock, undefined | Path]
findDOMNode()
findDOMNode: (
element) =>undefined|Node
Defined in: packages/editor/src/types/editor.ts:60
Parameters
element
PortableTextSpan | PortableTextObject | PortableTextTextBlock
Returns
undefined | Node
focus()
focus: () =>
void
Defined in: packages/editor/src/types/editor.ts:63
Returns
void
focusBlock()
focusBlock: () =>
undefined|PortableTextBlock
Defined in: packages/editor/src/types/editor.ts:64
Returns
undefined | PortableTextBlock
focusChild()
focusChild: () =>
undefined|PortableTextChild
Defined in: packages/editor/src/types/editor.ts:65
Returns
undefined | PortableTextChild
getFragment()
getFragment: () =>
undefined|PortableTextBlock[]
Defined in: packages/editor/src/types/editor.ts:67
Returns
undefined | PortableTextBlock[]
getSelection()
getSelection: () =>
EditorSelection
Defined in: packages/editor/src/types/editor.ts:66
Returns
getValue()
getValue: () =>
undefined|PortableTextBlock[]
Defined in: packages/editor/src/types/editor.ts:68
Returns
undefined | PortableTextBlock[]
hasBlockStyle()
hasBlockStyle: (
style) =>boolean
Defined in: packages/editor/src/types/editor.ts:69
Parameters
style
string
Returns
boolean
hasListStyle()
hasListStyle: (
listStyle) =>boolean
Defined in: packages/editor/src/types/editor.ts:70
Parameters
listStyle
string
Returns
boolean
insertBlock()
insertBlock: <
TSchemaType>(type,value?) =>Path
Defined in: packages/editor/src/types/editor.ts:71
Type Parameters
• TSchemaType extends object
Parameters
type
TSchemaType
value?
Returns
Path
insertBreak()
insertBreak: () =>
void
Defined in: packages/editor/src/types/editor.ts:79
Returns
void
insertChild()
insertChild: <
TSchemaType>(type,value?) =>Path
Defined in: packages/editor/src/types/editor.ts:75
Type Parameters
• TSchemaType extends object
Parameters
type
TSchemaType
value?
Returns
Path
isAnnotationActive()
isAnnotationActive: (
annotationType) =>boolean
Defined in: packages/editor/src/types/editor.ts:45
Parameters
annotationType
string
Returns
boolean
isCollapsedSelection()
isCollapsedSelection: () =>
boolean
Defined in: packages/editor/src/types/editor.ts:80
Returns
boolean
isExpandedSelection()
isExpandedSelection: () =>
boolean
Defined in: packages/editor/src/types/editor.ts:81
Returns
boolean
isMarkActive()
isMarkActive: (
mark) =>boolean
Defined in: packages/editor/src/types/editor.ts:82
Parameters
mark
string
Returns
boolean
isSelectionsOverlapping()
isSelectionsOverlapping: (
selectionA,selectionB) =>boolean
Defined in: packages/editor/src/types/editor.ts:83
Parameters
selectionA
selectionB
Returns
boolean
isVoid()
isVoid: (
element) =>boolean
Defined in: packages/editor/src/types/editor.ts:87
Parameters
element
PortableTextSpan | PortableTextObject | PortableTextTextBlock
Returns
boolean
marks()
marks: () =>
string[]
Defined in: packages/editor/src/types/editor.ts:88
Returns
string[]
redo()
redo: () =>
void
Defined in: packages/editor/src/types/editor.ts:89
Returns
void
removeAnnotation()
removeAnnotation: <
TSchemaType>(type) =>void
Defined in: packages/editor/src/types/editor.ts:90
Type Parameters
• TSchemaType extends object
Parameters
type
TSchemaType
Returns
void
select()
select: (
selection) =>void
Defined in: packages/editor/src/types/editor.ts:93
Parameters
selection
Returns
void
toggleBlockStyle()
toggleBlockStyle: (
blockStyle) =>void
Defined in: packages/editor/src/types/editor.ts:94
Parameters
blockStyle
string
Returns
void
toggleList()
toggleList: (
listStyle) =>void
Defined in: packages/editor/src/types/editor.ts:95
Parameters
listStyle
string
Returns
void
toggleMark()
toggleMark: (
mark) =>void
Defined in: packages/editor/src/types/editor.ts:96
Parameters
mark
string
Returns
void
undo()
undo: () =>
void
Defined in: packages/editor/src/types/editor.ts:97
Returns
void