@theredhead — Frontend Library - v1.0.0
    Preparing search index...

    Class UITemplateTool

    A toolbar tool that renders consumer-provided template content.

    The template receives the UITemplateTool instance as $implicit context, giving access to all base inputs.

    <ui-toolbar>
      <ui-template-tool id="custom">
        <ng-template let-tool>
          <span>Custom: {{ tool.label() }}</span>
        </ng-template>
      </ui-template-tool>
    </ui-toolbar>

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    ariaLabel disabled icon id itemAction label tooltip tpl

    Methods

    deactivate emitAction

    Constructors

    Properties

    ariaLabel: InputSignal<string> = ...

    Accessible label forwarded to the native element as aria-label.

    disabled: InputSignal<boolean> = ...

    Whether this item is disabled.

    icon: InputSignal<string | undefined> = ...

    SVG inner-content string for an optional icon (use UIIcons.Lucide.*).

    id: InputSignal<string> = ...

    Unique identifier for this toolbar item.

    itemAction: OutputEmitterRef<ToolActionEvent> = ...

    Emitted when the user triggers an action on this item.

    label: InputSignal<string> = ...

    Human-readable label shown in the tool.

    tooltip: InputSignal<string> = ...

    Tooltip text shown on pointer hover.

    tpl: Signal<TemplateRef<{ $implicit: UITemplateTool }> | undefined> = ...

    The consumer-provided template. Receives UITemplateTool as $implicit context.

    Methods

    • Deactivate (un-check / un-press) this item.

      No-op by default. Overridden by UIToggleTool to set checked to false, enabling radio-style exclusivity in UIToggleGroupTool.

      Returns void

    • Emit a ToolActionEvent for this item.

      Parameters

      • event: MouseEvent | null

        The originating mouse event, or null for programmatic triggers.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods