@umbraco-cms/backoffice
    Preparing search index...

    Interface UmbTiptapToolbarElementApi

    interface UmbTiptapToolbarElementApi {
        configuration?: UmbPropertyEditorConfigCollection;
        manifest?: ManifestTiptapToolbarExtension<MetaTiptapToolbarExtension>;
        destroy(): void;
        execute(editor?: Editor, ...args: unknown[]): void;
        isActive(editor?: Editor, ...args: unknown[]): boolean;
        isDisabled(editor?: Editor): boolean;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    configuration? manifest?
    destroy execute isActive isDisabled
    configuration?: UmbPropertyEditorConfigCollection

    The data type configuration for the property editor that the editor is used for. You can populate this manually if you are using the editor outside of a property editor with the UmbPropertyEditorConfigCollection object.

    This is only available when the editor is used in a property editor or populated manually.

    manifest?: ManifestTiptapToolbarExtension<MetaTiptapToolbarExtension>

    The manifest for the extension.

    • Executes the toolbar element action.

      Parameters

      • Optionaleditor: Editor

        The editor instance.

      • ...args: unknown[]

        Extra arguments, whose shape depends on the toolbar kind — e.g. the menu and styleMenu kinds pass the invoked MetaTiptapToolbarMenuItem as the first argument.

      Returns void

    • Checks if the toolbar element is active.

      Parameters

      • Optionaleditor: Editor

        The editor instance.

      • ...args: unknown[]

        Extra arguments, whose shape depends on the toolbar kind — e.g. the menu and styleMenu kinds pass the MetaTiptapToolbarMenuItem to check as the first argument.

      Returns boolean

      Returns true if the toolbar element is active.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods