API

---

Interface: EditorOptions<T, S>

Defined in: editor.ts:107

Options of createEditor.

Type Parameters

T

T extends DocNode

S

S extends StandardSchemaV1<T, T> | void = void

Properties

schema?

optional schema?: S

Defined in: editor.ts:114

Optional Standard Schema to validate unsafe edits.

---

doc

doc: T

Defined in: editor.ts:118

Initial document.

---

readonly?

optional readonly?: boolean

Defined in: editor.ts:122

The state editable or not.

---

isBlock?

optional isBlock?: (node) => boolean

Defined in: editor.ts:126

TODO

Parameters

node

HTMLElement

Returns

boolean

---

onWarn?

optional onWarn?: (message) => void

Defined in: editor.ts:132

Callback invoked when errors happen.

Parameters

message

string

Returns

void

Default

console.warn

---

onError?

optional onError?: (message) => never

Defined in: editor.ts:138

Callback invoked when errors happen.

Parameters

message

string

Returns

never

Default

throw new Error(message)