RichNode
interface exported by @mwillbanks/tuil-editor.
interface
Public interface exported by @mwillbanks/tuil-editor.
export interface RichNode {
readonly [key: string]: unknown;
readonly type: RichNodeType;
readonly text?: string;
readonly level?: number;
readonly attributes?: Readonly<Record<string, unknown>>;
readonly marks?: readonly RichMark[];
readonly children?: readonly RichNode[];
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
type | RichNodeType | Yes | The type member uses the RichNodeType contract. | RichNodeType |
text | string | undefined | No | The text member uses the string | undefined contract. | — |
level | number | undefined | No | The level member uses the number | undefined contract. | — |
attributes | Readonly<Record<string, unknown>> | undefined | No | The attributes member uses the Readonly<Record<string, unknown>> | undefined contract. | — |
marks | readonly RichMark[] | undefined | No | The marks member uses the readonly RichMark[] | undefined contract. | RichMark |
children | readonly RichNode[] | undefined | No | The children member uses the readonly RichNode[] | undefined contract. | RichNode |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference