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

    Interface CommandButtonOptions<STATE, CONTEXT, ARGS>

    interface CommandButtonOptions<STATE = any, CONTEXT = any, ARGS = void> {
        commandState?: STATE;
        disabled?: boolean;
        disableHover?: boolean;
        groupKey?: string;
        icon?:
            | ReactNode
            | ((command: ResolvedCommand<STATE, CONTEXT, ARGS>) => ReactNode);
        label?:
            | ReactNode
            | ((command: ResolvedCommand<STATE, CONTEXT, ARGS>) => ReactNode);
        propsTooltip?: any;
        selected?: boolean;
        shortcut?: IKeyStroke | IKeyStroke[];
        showLabel?: boolean;
        variant?: CommandButtonType;
    }

    Type Parameters

    • STATE = any
    • CONTEXT = any
    • ARGS = void

    Hierarchy (View Summary)

    • Omit<React.HTMLAttributes<HTMLElement>, "color" | "label">
    Index
    commandState? disabled? disableHover? groupKey? icon? label? propsTooltip? selected? shortcut? showLabel? variant?
    commandState?: STATE

    Optional state for this specific command button.

    to undefined
    disabled?: boolean
    disableHover?: boolean
    groupKey?: string

    The panel/group the button renders in (e.g. 'contextMenu', 'cellStyle') — selects the command's matching groupLabels variant. Omit for the full label. (Named groupKey, NOT "scope" — command scopes are contributors; this is purely a presentation surface.)

    icon?:
        | ReactNode
        | ((command: ResolvedCommand<STATE, CONTEXT, ARGS>) => ReactNode)
    label?:
        | ReactNode
        | ((command: ResolvedCommand<STATE, CONTEXT, ARGS>) => ReactNode)
    propsTooltip?: any

    Tooltip properties. If this is specified then the tooltips are used. Do not provide a child as this component will be the child.

    selected?: boolean
    shortcut?: IKeyStroke | IKeyStroke[]

    The shortcut to display.

    This is display only and doesn't actually track the shortcut. Override the display for the shortcut on the command (if available).

    showLabel?: boolean

    Render the label as visible button content (alongside the icon) rather than tooltip-only. Toolbar buttons are icon-only by default; menu items always show their label. See CommandButtonEntry.showLabel for the entry-level equivalent.

    false
    variant?: CommandButtonType

    How the button will be styles.

    CommandButtonType.Toolbar

    Settings
    Member Visibility

    On This Page
    Properties