SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface ToggleGroupButtonProps

    interface ToggleGroupButtonProps {
        commandState?: any;
        createTooltip?: (props: TooltipProps, disabled: boolean) => Element;
        defaultIcon?: ReactNode;
        dense?: boolean;
        disabled?: boolean;
        disableHover?: boolean;
        groupKey?: string;
        icon?: ReactNode | ((command: ResolvedCommand) => ReactNode);
        label?: ReactNode | ((command: ResolvedCommand) => ReactNode);
        members?: (string | CommandButtonEntry<any, any> | null)[];
        onPopupClose?: () => void;
        onPopupOpen?: () => void;
        onQuickClick?: (e: MouseEvent<Element>) => void;
        outlined?: boolean | OutlineBorder;
        parentFloat?: FloatReference;
        primary?: boolean;
        projectAs?: ToggleProjection;
        propsButton?: BoxProps;
        propsPopup?: Partial<ExhibitFloatPanelProps>;
        propsQuickButton?: ExhibitQuickButtonProps;
        quickCommand?: string;
        registry?: ICommandButtonRegistry;
        renderQuickButton?: (props: ExhibitQuickButtonProps) => ReactNode;
        ripple?: ReactNode;
        selected?: boolean;
        showLabel?: boolean;
        tooltip?: NonNullable<ReactNode>;
        variant?: CommandButtonType;
    }

    Hierarchy (View Summary)

    Index
    commandState? createTooltip? defaultIcon? dense? disabled? disableHover? groupKey? icon? label? members? onPopupClose? onPopupOpen? onQuickClick? outlined? parentFloat? primary? projectAs? propsButton? propsPopup? propsQuickButton? quickCommand? registry? renderQuickButton? ripple? selected? showLabel? tooltip? variant?
    commandState?: any

    Optional state for this specific command button.

    to undefined
    createTooltip?: (props: TooltipProps, disabled: boolean) => Element

    Allows for custom tooltip creation

    defaultIcon?: ReactNode

    Fallback icon for 'icon' projection when no member toggle is active.

    dense?: boolean
    disabled?: boolean
    disableHover?: boolean
    groupKey?: string

    Key of a CommandButtonEntry registered in the ICommandButtonRegistry. Also the resolution scope for the panel's members (command.getLabel(groupKey)).

    Provide either groupKey (registered) or members (inline), not both.

    icon?: ReactNode | ((command: ResolvedCommand) => ReactNode)
    label?: ReactNode | ((command: ResolvedCommand) => ReactNode)
    members?: (string | CommandButtonEntry<any, any> | null)[]

    An inline, anonymous member list - the un-registered alternative to groupKey (replaces SimpleCommandPopupButton's popupCommandKeys).

    onPopupClose?: () => void
    onPopupOpen?: () => void
    onQuickClick?: (e: MouseEvent<Element>) => void

    If this set then the popup becomes a split button.

    outlined?: boolean | OutlineBorder
    parentFloat?: FloatReference
    primary?: boolean

    If the icon button is a primary icon button. This may change the color of the text and icon.

    false
    projectAs?: ToggleProjection

    How the active toggle projects onto the button head.

    'quick'

    propsButton?: BoxProps
    propsPopup?: Partial<ExhibitFloatPanelProps>
    propsQuickButton?: ExhibitQuickButtonProps
    quickCommand?: string
    registry?: ICommandButtonRegistry

    Registry to resolve the group / renderers from.

    the registry from useCommandButtonRegistry (context or shared singleton).

    renderQuickButton?: (props: ExhibitQuickButtonProps) => ReactNode
    ripple?: ReactNode

    A ripple surface rendered inside the executing (quick) button. Supplied by CommandPopupButton via useManagedRipple — an always-mounted TouchRipple that can flash on any command dispatch (MUI's built-in ripple is lazy-mounted and can't fire for remote executes). When set, the quick button disables its own ripple and hosts this one instead.

    selected?: boolean

    Render as selected,

    showLabel?: boolean

    Render the label as visible button content (alongside any icon / split-toggle checkmark) rather than as tooltip-only. Toolbar (icon) buttons are icon-only by default. Menu items always show the label regardless.

    false
    tooltip?: NonNullable<ReactNode>

    Tooltip title. Zero-length titles string are never displayed.

    variant?: CommandButtonType

    Styling

    CommandButtonType.Toolbar

    Settings
    Member Visibility

    On This Page
    Properties