SheetXL - v0.3.20
    Preparing search index...

    Interface ColorCommandButtonProps

    Wraps ColorPopupButton with a command.

    interface ColorCommandButtonProps {
        commandHook?: ICommandHook<any, any>;
        createTooltip?: (props: TooltipProps, disabled: boolean) => Element;
        icon?: ReactNode;
        isSplit?: boolean;
        onQuickClick?: (e: MouseEvent<Element>) => void;
        primary?: boolean;
        quickColor?: IColor;
        selected?: boolean;
        shouldCloseFloatAll?: boolean;
        tooltip?: NonNullable<ReactNode>;
        TouchRippleProps?: Partial<any>;
        touchRippleRef?: Ref<any>;
        variant?: CommandButtonType;
    }

    Hierarchy

    • Omit<ColorPopupButtonProps, "selectedColor" | "variant">
      • ColorCommandButtonProps
    Index

    Properties

    commandHook? createTooltip? icon? isSplit? onQuickClick? primary? quickColor? selected? shouldCloseFloatAll? tooltip? TouchRippleProps? touchRippleRef? variant?

    Properties

    commandHook?: ICommandHook<any, any>

    Allow for listeners against a specific buttons execute rather than the command.

    Useful when knowing the specific button that executed a command is required. (For example when closing menus or restoring focus)

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

    Allows for custom tooltip creation

    icon?: ReactNode

    Popup button icon.

    isSplit?: boolean

    Hint to indicate to the popup to behave like a split button even if no commands is available.

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

    If this set then the popup becomes a split button.

    primary?: boolean

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

    false
    quickColor?: IColor

    A short cut for a quick color. This is generally the last color chosen

    selected?: boolean

    Render as selected,

    shouldCloseFloatAll?: boolean

    When closing the popup closeAll movables or just the current.

    true
    tooltip?: NonNullable<ReactNode>

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

    TouchRippleProps?: Partial<any>

    Props applied to the TouchRipple element.

    touchRippleRef?: Ref<any>

    A ref that points to the TouchRipple element.

    variant?: CommandButtonType

    Styling

    CommandButtonType.Toolbar

    Settings

    Member Visibility

    On This Page

    Properties