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

    Interface PresetCellStylesCommandButtonProps

    interface PresetCellStylesCommandButtonProps {
        commandKey: string;
        commandState?: any;
        createPopupPanel?: (props: ExhibitPopupPanelProps) => ReactNode;
        createTooltip?: (props: TooltipProps, disabled: boolean) => Element;
        dense?: boolean;
        disabled?: boolean;
        disableHover?: boolean;
        groupKey?: string;
        icon?: ReactNode | ((command: ResolvedCommand) => ReactNode);
        label?: ReactNode | ((command: ResolvedCommand) => ReactNode);
        onPopupClose?: () => void;
        onPopupOpen?: () => void;
        onQuickClick?: (e: MouseEvent<Element>) => void;
        onSelectNamed?: (style: INamed) => void;
        outlined?: boolean | OutlineBorder;
        parentFloat?: FloatReference;
        primary?: boolean;
        propsButton?: BoxProps;
        propsPopup?: Partial<ExhibitFloatPanelProps>;
        propsQuickButton?: ExhibitQuickButtonProps;
        quickCommand?: string;
        renderQuickButton?: (props: ExhibitQuickButtonProps) => ReactNode;
        ripple?: ReactNode;
        selected?: boolean;
        selectedNamed?: INamed;
        showLabel?: boolean;
        tooltip?: NonNullable<ReactNode>;
        usePreviewIcon?: boolean;
        variant?: CommandButtonType;
    }

    Hierarchy

    • CommandPopupButtonProps
      • PresetCellStylesCommandButtonProps
    Index
    commandKey commandState? createPopupPanel? createTooltip? dense? disabled? disableHover? groupKey? icon? label? onPopupClose? onPopupOpen? onQuickClick? onSelectNamed? outlined? parentFloat? primary? propsButton? propsPopup? propsQuickButton? quickCommand? renderQuickButton? ripple? selected? selectedNamed? showLabel? tooltip? usePreviewIcon? variant?
    commandKey: string
    commandState?: any

    Optional state for this specific command button.

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

    Allows for custom tooltip creation

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

    The panel/group this renders in — selects groupLabels variants (see CommandButtonOptions.groupKey).

    icon?: ReactNode | ((command: ResolvedCommand) => ReactNode)
    label?: ReactNode | ((command: ResolvedCommand) => ReactNode)
    onPopupClose?: () => void
    onPopupOpen?: () => void
    onQuickClick?: (e: MouseEvent<Element>) => void

    If this set then the popup becomes a split button.

    onSelectNamed?: (style: INamed) => void
    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
    propsButton?: BoxProps
    propsPopup?: Partial<ExhibitFloatPanelProps>
    propsQuickButton?: ExhibitQuickButtonProps
    quickCommand?: string
    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,

    selectedNamed?: INamed
    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.

    usePreviewIcon?: boolean
    variant?: CommandButtonType

    Styling

    CommandButtonType.Toolbar

    Settings
    Member Visibility

    On This Page
    Properties