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

    Class UIToggleTool

    A toolbar tool that toggles between checked and unchecked states.

    Emits a ToolActionEvent on each click (regardless of the new checked state). The consumer can read the new state from (itemRef as UIToggleTool).checked().

    deactivate sets checked to false, allowing UIToggleGroupTool to enforce radio-style exclusivity.

    <ui-toolbar (toolAction)="onAction($event)">
      <ui-toggle-tool id="bold" label="Bold" [(checked)]="isBold" />
    </ui-toolbar>

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    ariaLabel checked disabled icon id itemAction label tooltip

    Methods

    deactivate emitAction

    Constructors

    Properties

    ariaLabel: InputSignal<string> = ...

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

    checked: ModelSignal<boolean> = ...

    Two-way bindable checked state.

    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.

    Methods

    • Sets checked to false.

      Called by UIToggleGroupTool to deactivate siblings when another toggle in the group is activated.

      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