AbstractOptionalcontrollerAlias: UmbControllerAliasOptionalconfigurationThe data type configuration for the property editor that the editor is used for.
OptionalmanifestThe manifest for the extension.
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Optionaloptions: boolean | AddEventListenerOptionsCallback method called with the resolved context instance or undefined.
Reference to the created Context Consumer Controller instance
Subscribe to a context. The callback fires when the context resolves, again if the context is replaced, and can also be invoked with undefined if the context is unprovided or the host disconnects. Use this whenever a controller or element needs the context at setup time — both for ongoing observation and for reading values immediately on resolve. This is the default choice; prefer it over getContext unless the context is only needed inside a later user action.
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
AbstractexecuteA method to execute the toolbar element action.
Optionaleditor: Editor
The editor instance.
Extra arguments, whose shape depends on the toolbar kind — e.g. the menu and styleMenu
kinds pass the invoked MetaTiptapToolbarMenuItem as the first argument.
Optionaloptions: UmbClassGetContextOptions
Options for resolving the context once, including timeout-related behavior such as preventTimeout.
A Promise resolving to the Context API instance when available, or undefined when applicable.
Retrieve a context once as a Promise. Use this only when the context is first needed inside a user action or event handler that runs later (for example a button click, a property action, or an entity action execute()). For setup-time access — including a single immediate read — use consumeContext instead so the controller lifecycle handles resolution and cleanup. The returned Promise may reject if the context is not found before the default timeout; callers should handle rejection and/or pass preventTimeout in the options when waiting longer is expected.
Informs the toolbar element if it is active or not. It uses the manifest meta alias to check if the toolbar element is active.
Optionaleditor: Editor
The editor instance.
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 true if the toolbar element is active.
Informs the toolbar element if it is disabled or not.
Optionaleditor: Editor
The editor instance.
Returns true if the toolbar element is disabled.
An Observable to observe from.
Optionalcallback: ObserverCallback<UmbObserverValueType<ObservableType>>
Callback method called when data is changed.
OptionalcontrollerAlias: UmbControllerAlias | null
Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Reference to the created Observer Controller instance.
The API instance to be exposed.
Reference to the created Context Provider Controller instance
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Optionaloptions: boolean | EventListenerOptions
Base class for
actionButtonkind toolbar extensions.Provides a default
isDisabledimplementation that returns!isActive(editor), meaning the button is disabled when the action cannot be performed.Extensions using this base class should override
isActiveto return whether the action can be executed in the current editor state.