Interface UmbTiptapExtensionApi

interface UmbTiptapExtensionApi {
    manifest?: ManifestTiptapExtension<MetaTiptapExtension>;
    destroy(): void;
    getStyles(): undefined | null | CSSResultGroup;
    getTiptapExtensions(
        args?: UmbTiptapExtensionArgs,
    ): (Node<any, any> | Extension<any, any> | Mark<any, any>)[];
    setEditor(editor: Editor): void;
}

Hierarchy (View Summary, Expand)

UmbApi
- UmbTiptapExtensionApi

Implemented by

UmbTiptapExtensionApiBase

Index

Properties

Methods

destroy getStyles getTiptapExtensions setEditor

Properties

`Optional`manifest

manifest?: ManifestTiptapExtension<MetaTiptapExtension>

The manifest for the extension.

Methods

destroy

destroy(): void
Returns void
Inherited from UmbApi.destroy
- Defined in src/libs/extension-api/models/api.interface.ts:2

getStyles

getStyles(): undefined | null | CSSResultGroup
Gets the styles for the extension

Returns undefined | null | CSSResultGroup
- Defined in src/packages/tiptap/extensions/types.ts:25

getTiptapExtensions

getTiptapExtensions(
args?: UmbTiptapExtensionArgs,
): (Node<any, any> | Extension<any, any> | Mark<any, any>)[]
Gets the Tiptap extensions for the editor.
Parameters
- Optionalargs: UmbTiptapExtensionArgs
Returns (Node<any, any> | Extension<any, any> | Mark<any, any>)[]
- Defined in src/packages/tiptap/extensions/types.ts:30

setEditor

setEditor(editor: Editor): void
Sets the editor instance to the extension.
Parameters
- editor: Editor
Returns void
- Defined in src/packages/tiptap/extensions/types.ts:20