EditorDecoration
interface exported by @mwillbanks/tuil-editor.
interface
Public interface exported by @mwillbanks/tuil-editor.
export interface EditorDecoration {
readonly id: string;
readonly range: EditorRange;
readonly kind: "highlight" | "underline" | "line" | "gutter" | "widget";
readonly className?: string;
readonly data?: unknown;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | Yes | The id member uses the string contract. | — |
range | EditorRange | Yes | The range member uses the EditorRange contract. | EditorRange |
kind | "highlight" | "underline" | "line" | "gutter" | "widget" | Yes | The kind member uses the "highlight" | "underline" | "line" | "gutter" | "widget" contract. | — |
className | string | undefined | No | The className member uses the string | undefined contract. | — |
data | unknown | No | The data member uses the unknown contract. | — |
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