EditorProvider
interface exported by @mwillbanks/tuil-editor.
interface
Public interface exported by @mwillbanks/tuil-editor.
export interface EditorProvider extends EditorBackend {
readonly documentTypes?: readonly string[];
readonly rendererCapabilities?: readonly string[];
readonly inputCapabilities?: readonly string[];
readonly staticModes?: readonly string[];
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
documentTypes | readonly string[] | undefined | No | The documentTypes member uses the readonly string[] | undefined contract. | — |
rendererCapabilities | readonly string[] | undefined | No | The rendererCapabilities member uses the readonly string[] | undefined contract. | — |
inputCapabilities | readonly string[] | undefined | No | The inputCapabilities member uses the readonly string[] | undefined contract. | — |
staticModes | readonly string[] | undefined | No | The staticModes member uses the readonly string[] | undefined contract. | — |
id | string | Yes | The id member uses the string contract. | — |
version | string | Yes | The version member uses the string contract. | — |
capabilities | ReadonlySet<EditorCapability> | Yes | The capabilities member uses the ReadonlySet<EditorCapability> contract. | EditorCapability |
create | (options: EditorProviderOptions) => EditorSession | Yes | The create member uses the (options: EditorProviderOptions) => EditorSession contract. | EditorProviderOptions, EditorSession |
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