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

    Class UIToggleGroupTool

    A radio-style grouping container for toggle toolbar items.

    When a child item emits an action, all other children are deactivated via their deactivate() method, effectively enforcing single-selection.

    Re-emits the activated child's itemAction event so the parent UIToolbar receives it seamlessly.

    <ui-toolbar (toolAction)="onAction($event)">
      <ui-toggle-group-tool id="alignment">
        <ui-toggle-tool id="left" label="Left" />
        <ui-toggle-tool id="center" label="Center" />
        <ui-toggle-tool id="right" label="Right" />
      </ui-toggle-group-tool>
    </ui-toolbar>

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    ariaLabel childItems disabled icon id itemAction label tooltip

    Methods

    deactivate emitAction

    Constructors

    Properties

    ariaLabel: InputSignal<string> = ...

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

    childItems: Signal<readonly UIToolbarItem[]> = ...

    Direct UIToolbarItem content children of this group. Expected to be UIToggleTool instances.

    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

    • 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