Class Schema

The set of node and mark types a document may contain, plus factory helpers. Requires a text node type and a top-level type (default "doc").

Index

Constructors

Properties

marks nodes spec textType topType

Methods

firstTextblockType mark markType node nodeType text

Constructors

constructor

new Schema(spec: SchemaSpec): Schema
Parameters
- spec: SchemaSpec
Returns Schema
- Defined in packages/core/src/model/schema.ts:211

Properties

`Readonly`marks

marks: Readonly<Record<string, MarkType>>

`Readonly`nodes

nodes: Readonly<Record<string, NodeType>>

`Readonly`spec

spec: SchemaSpec

`Readonly`textType

textType: NodeType

`Readonly`topType

topType: NodeType

Methods

firstTextblockType

firstTextblockType(): NodeType
First non-text node type with inline content, used as the default block.

Returns NodeType
- Defined in packages/core/src/model/schema.ts:278

mark

mark(name: string, attrs?: Readonly<Record<string, unknown>>): Mark
Parameters
- name: string
- Optionalattrs: Readonly<Record<string, unknown>>
Returns Mark
- Defined in packages/core/src/model/schema.ts:273

markType

markType(name: string): MarkType
Parameters
- name: string
Returns MarkType
- Defined in packages/core/src/model/schema.ts:253

node

node(
    name: string,
    attrs?: Readonly<Record<string, unknown>>,
    content?: Fragment | readonly EditorNode[],
    marks?: readonly Mark[],
): EditorNode
Parameters
- name: string
- Optionalattrs: Readonly<Record<string, unknown>>
- Optionalcontent: Fragment | readonly EditorNode[]
- Optionalmarks: readonly Mark[]
Returns EditorNode
- Defined in packages/core/src/model/schema.ts:259

nodeType

nodeType(name: string): NodeType
Parameters
- name: string
Returns NodeType
- Defined in packages/core/src/model/schema.ts:247

text

text(text: string, marks?: readonly Mark[]): TextNode
Parameters
- text: string
- marks: readonly Mark[] = noMarks
Returns TextNode
- Defined in packages/core/src/model/schema.ts:269