Class UmbTiptapToolbarActionButtonApiBase`Abstract`

Base class for actionButton kind toolbar extensions.

Provides a default isDisabled implementation that returns !isActive(editor), meaning the button is disabled when the action cannot be performed.

Extensions using this base class should override isActive to return whether the action can be executed in the current editor state.

Hierarchy (View Summary)

UmbTiptapToolbarElementApiBase
- UmbTiptapToolbarActionButtonApiBase

Constructors

constructor

new UmbTiptapToolbarActionButtonApiBase(
host: UmbControllerHost,
controllerAlias?: UmbControllerAlias,
): UmbTiptapToolbarActionButtonApiBase
Parameters
- host: UmbControllerHost
- OptionalcontrollerAlias: UmbControllerAlias
Returns UmbTiptapToolbarActionButtonApiBase
Inherited from UmbTiptapToolbarElementApiBase.constructor
- Defined in src/libs/class-api/class.mixin.ts:19

Properties

_host

_host: UmbControllerHost

`Optional`configuration

configuration?: UmbPropertyEditorConfigCollection

The data type configuration for the property editor that the editor is used for.

`Optional`manifest

manifest?: ManifestTiptapToolbarExtension<MetaTiptapToolbarExtension>

The manifest for the extension.

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbTiptapToolbarElementApiBase.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbTiptapToolbarElementApiBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbTiptapToolbarElementApiBase.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Inherited from UmbTiptapToolbarElementApiBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

destroy(): void
Returns void
Inherited from UmbTiptapToolbarElementApiBase.destroy
- Defined in src/libs/controller-api/controller.interface.ts:6

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbTiptapToolbarElementApiBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

`Abstract`execute

execute(editor?: Editor): void
A method to execute the toolbar element action.
Parameters
- Optionaleditor: Editor
  The editor instance.
Returns void
See
Inherited from UmbTiptapToolbarElementApiBase.execute
- Defined in src/packages/tiptap/extensions/tiptap-toolbar-element-api-base.ts:24

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Inherited from UmbTiptapToolbarElementApiBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

isActive

isActive(editor?: Editor): boolean
Informs the toolbar element if it is active or not. It uses the manifest meta alias to check if the toolbar element is active.
Parameters
- Optionaleditor: Editor
  The editor instance.
Returns boolean
Returns true if the toolbar element is active.

See
Inherited from UmbTiptapToolbarElementApiBase.isActive
- Defined in src/packages/tiptap/extensions/tiptap-toolbar-element-api-base.ts:32

isDisabled

isDisabled(editor?: Editor): boolean
Informs the toolbar element if it is disabled or not.
Parameters
- Optionaleditor: Editor
  The editor instance.
Returns boolean
Returns true if the toolbar element is disabled.

See
Overrides UmbTiptapToolbarElementApiBase.isDisabled
- Defined in src/packages/tiptap/extensions/tiptap-toolbar-action-button-api-base.ts:14

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  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.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Inherited from UmbTiptapToolbarElementApiBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbTiptapToolbarElementApiBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbTiptapToolbarElementApiBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbTiptapToolbarElementApiBase.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbTiptapToolbarElementApiBase.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

Class UmbTiptapToolbarActionButtonApiBaseAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UmbTiptapToolbarActionButtonApiBase

Properties

_host

Optionalconfiguration

Optionalmanifest

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

Abstractexecute

Parameters

Returns void

See

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getUmbControllers

Parameters

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

hostConnected

Returns void

hostDisconnected

Returns void

isActive

Parameters

Returns boolean

See

isDisabled

Parameters

Returns boolean

See

observe

Type Parameters

Parameters

Returns SpecificR

Description

Memberof

provideContext

Type Parameters

Parameters

Returns UmbContextProviderController<R>

Description

Memberof

removeEventListener

Parameters

Class UmbTiptapToolbarActionButtonApiBase`Abstract`

`Optional`configuration

`Optional`manifest

`Abstract`execute