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

    Interface ColorPopupButtonProps

    interface ColorPopupButtonProps {
        compareRGB?: boolean;
        createTooltip?: (props: TooltipProps, disabled: boolean) => Element;
        darkMode?: boolean;
        dense?: boolean;
        disabled?: boolean;
        disableHover?: boolean;
        icon?: ReactNode | (() => ReactNode);
        label?: ReactNode;
        onPopupClose?: () => void;
        onPopupOpen?: () => void;
        onPreviewColor?: (color: IColor | null) => void;
        onPreviewColorImmediate?: (color: IColor | null) => void;
        onQuickClick?: (e: MouseEvent<Element>) => void;
        onSelectColor?: (color: IColor | null, isCustom: boolean) => void;
        outlined?: boolean | OutlineBorder;
        parentFloat?: FloatReference;
        primary?: boolean;
        propsButton?: BoxProps;
        propsPanel?: Partial<ColorPanelProps>;
        propsPopup?: Partial<ExhibitFloatPanelProps>;
        propsQuickButton?: ExhibitQuickButtonProps;
        quickColor?: IColor;
        renderQuickButton?: (props: ExhibitQuickButtonProps) => ReactNode;
        ripple?: ReactNode;
        selected?: boolean;
        selectedColor: IColor | null;
        shouldCloseFloatAll?: boolean;
        showLabel?: boolean;
        tooltip?: NonNullable<ReactNode>;
        variant?: PopupButtonType;
    }

    Hierarchy

    • Omit<ExhibitPopupIconButtonProps, "color" | "createPopupPanel">
      • ColorPopupButtonProps
    Index
    compareRGB? createTooltip? darkMode? dense? disabled? disableHover? icon? label? onPopupClose? onPopupOpen? onPreviewColor? onPreviewColorImmediate? onQuickClick? onSelectColor? outlined? parentFloat? primary? propsButton? propsPanel? propsPopup? propsQuickButton? quickColor? renderQuickButton? ripple? selected? selectedColor shouldCloseFloatAll? showLabel? tooltip? variant?
    compareRGB?: boolean
    createTooltip?: (props: TooltipProps, disabled: boolean) => Element

    Allows for custom tooltip creation

    darkMode?: boolean
    dense?: boolean
    disabled?: boolean
    disableHover?: boolean
    icon?: ReactNode | (() => ReactNode)
    label?: ReactNode
    onPopupClose?: () => void
    onPopupOpen?: () => void
    onPreviewColor?: (color: IColor | null) => void
    onPreviewColorImmediate?: (color: IColor | null) => void
    onQuickClick?: (e: MouseEvent<Element>) => void

    If this set then the popup becomes a split button.

    onSelectColor?: (color: IColor | null, isCustom: boolean) => 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
    propsPanel?: Partial<ColorPanelProps>
    propsPopup?: Partial<ExhibitFloatPanelProps>
    propsQuickButton?: ExhibitQuickButtonProps
    quickColor?: IColor

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

    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,

    selectedColor: IColor | null

    null means no color of its own — the AUTO swatch is the selected one.

    shouldCloseFloatAll?: boolean

    When closing the popup closeAll movables or just the current.

    true
    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?: PopupButtonType

    Rendering styles

    to Toolbar

    Settings
    Member Visibility

    On This Page
    Properties