EditableAPI

Properties

activeAnnotations()

activeAnnotations: () => PortableTextObject[]

Returns

PortableTextObject[]

Defined in

packages/editor/src/types/editor.ts:44

addAnnotation()

addAnnotation: <TSchemaType>(type, value?) => undefined | { markDefPath: Path; markDefPaths: Path[]; spanPath: Path; }

Type Parameters

• TSchemaType extends object

Parameters

type

TSchemaType

value?

Returns

undefined | { markDefPath: Path; markDefPaths: Path[]; spanPath: Path; }

Defined in

packages/editor/src/types/editor.ts:46

blur()

blur: () => void

Returns

void

Defined in

packages/editor/src/types/editor.ts:52

delete()

delete: (selection, options?) => void

Parameters

selection

EditorSelection

options?

EditableAPIDeleteOptions

Returns

void

Defined in

packages/editor/src/types/editor.ts:53

findByPath()

findByPath: (path) => [undefined | PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>, undefined | Path]

Parameters

path

Path

Returns

Defined in

packages/editor/src/types/editor.ts:57

findDOMNode()

findDOMNode: (element) => undefined | Node

Parameters

element

PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>

Returns

undefined | Node

Defined in

packages/editor/src/types/editor.ts:60

focus()

focus: () => void

Returns

void

Defined in

packages/editor/src/types/editor.ts:63

focusBlock()

focusBlock: () => undefined | PortableTextBlock

Returns

undefined | PortableTextBlock

Defined in

packages/editor/src/types/editor.ts:64

focusChild()

focusChild: () => undefined | PortableTextChild

Returns

undefined | PortableTextChild

Defined in

packages/editor/src/types/editor.ts:65

getFragment()

getFragment: () => undefined | PortableTextBlock[]

Returns

undefined | PortableTextBlock[]

Defined in

packages/editor/src/types/editor.ts:67

getSelection()

getSelection: () => EditorSelection

Returns

EditorSelection

Defined in

packages/editor/src/types/editor.ts:66

getValue()

getValue: () => undefined | PortableTextBlock[]

Returns

undefined | PortableTextBlock[]

Defined in

packages/editor/src/types/editor.ts:68

hasBlockStyle()

hasBlockStyle: (style) => boolean

Parameters

style

string

Returns

boolean

Defined in

packages/editor/src/types/editor.ts:69

hasListStyle()

hasListStyle: (listStyle) => boolean

Parameters

listStyle

string

Returns

boolean

Defined in

packages/editor/src/types/editor.ts:70

insertBlock()

insertBlock: <TSchemaType>(type, value?) => Path

Type Parameters

• TSchemaType extends object

Parameters

type

TSchemaType

value?

Returns

Path

Defined in

packages/editor/src/types/editor.ts:71

insertBreak()

insertBreak: () => void

Returns

void

Defined in

packages/editor/src/types/editor.ts:79

insertChild()

insertChild: <TSchemaType>(type, value?) => Path

Type Parameters

• TSchemaType extends object

Parameters

type

TSchemaType

value?

Returns

Path

Defined in

packages/editor/src/types/editor.ts:75

isAnnotationActive()

isAnnotationActive: (annotationType) => boolean

Parameters

annotationType

string

Returns

boolean

Defined in

packages/editor/src/types/editor.ts:45

isCollapsedSelection()

isCollapsedSelection: () => boolean

Returns

boolean

Defined in

packages/editor/src/types/editor.ts:80

isExpandedSelection()

isExpandedSelection: () => boolean

Returns

boolean

Defined in

packages/editor/src/types/editor.ts:81

isMarkActive()

isMarkActive: (mark) => boolean

Parameters

mark

string

Returns

boolean

Defined in

packages/editor/src/types/editor.ts:82

isSelectionsOverlapping()

isSelectionsOverlapping: (selectionA, selectionB) => boolean

Parameters

selectionA

EditorSelection

selectionB

EditorSelection

Returns

boolean

Defined in

packages/editor/src/types/editor.ts:83

isVoid()

isVoid: (element) => boolean

Parameters

element

PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>

Returns

boolean

Defined in

packages/editor/src/types/editor.ts:87

marks()

marks: () => string[]

Returns

string[]

Defined in

packages/editor/src/types/editor.ts:88

redo()

redo: () => void

Returns

void

Defined in

packages/editor/src/types/editor.ts:89

removeAnnotation()

removeAnnotation: <TSchemaType>(type) => void

Type Parameters

• TSchemaType extends object

Parameters

type

TSchemaType

Returns

void

Defined in

packages/editor/src/types/editor.ts:90

select()

select: (selection) => void

Parameters

selection

EditorSelection

Returns

void

Defined in

packages/editor/src/types/editor.ts:93

toggleBlockStyle()

toggleBlockStyle: (blockStyle) => void

Parameters

blockStyle

string

Returns

void

Defined in

packages/editor/src/types/editor.ts:94

toggleList()

toggleList: (listStyle) => void

Parameters

listStyle

string

Returns

void

Defined in

packages/editor/src/types/editor.ts:95

toggleMark()

toggleMark: (mark) => void

Parameters

mark

string

Returns

void

Defined in

packages/editor/src/types/editor.ts:96

undo()

undo: () => void

Returns

void

Defined in

packages/editor/src/types/editor.ts:97