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

    Interface BorderCommandButtonProps

    interface BorderCommandButtonProps {
        autoColor?: IColor;
        autoStrokeStyle?: StrokeStyle;
        commandKey?: string;
        createBorder?: (props: Partial<IBorders.Properties>) => IBorders;
        createTooltip?: (props: TooltipProps, disabled: boolean) => Element;
        darkMode?: boolean;
        dense?: boolean;
        disabled?: boolean;
        disableHover?: boolean;
        icon?: ReactNode | ((command: any) => ReactNode);
        label?: ReactNode | ((command: any) => ReactNode);
        onPopupClose?: () => void;
        onPopupOpen?: () => void;
        onPreviewBorder?: (border: Partial<Properties> | null) => void;
        onQuickClick?: (e: MouseEvent<Element>) => void;
        onSelectBorder?: (border: Partial<Properties> | null) => void;
        outlined?: boolean | OutlineBorder;
        parentFloat?: FloatReference;
        primary?: boolean;
        propsButton?: BoxProps;
        propsPopup?: Partial<ExhibitFloatPanelProps>;
        propsQuickButton?: ExhibitQuickButtonProps;
        renderQuickButton?: (props: ExhibitQuickButtonProps) => ReactNode;
        ripple?: ReactNode;
        schemeLookup?: SchemeLookup;
        selected?: boolean;
        selectedBorder?: Partial<Properties>;
        showLabel?: boolean;
        showStylingBefore?: boolean;
        tooltip?: NonNullable<ReactNode>;
        variant?: CommandButtonType;
    }

    Hierarchy

    Index
    autoColor? autoStrokeStyle? commandKey? createBorder? createTooltip? darkMode? dense? disabled? disableHover? icon? label? onPopupClose? onPopupOpen? onPreviewBorder? onQuickClick? onSelectBorder? outlined? parentFloat? primary? propsButton? propsPopup? propsQuickButton? renderQuickButton? ripple? schemeLookup? selected? selectedBorder? showLabel? showStylingBefore? tooltip? variant?
    autoColor?: IColor

    If autoColor is set the a special Swatch is create that will disable this color. When it is selected or previewed the color passed will be null any consumer will then know to use the auto color

    autoStrokeStyle?: StrokeStyle

    If no values are specified

    commandKey?: string
    createBorder?: (props: Partial<IBorders.Properties>) => IBorders

    Create a border.

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

    Allows for custom tooltip creation

    darkMode?: boolean
    dense?: boolean
    disabled?: boolean
    disableHover?: boolean
    icon?: ReactNode | ((command: any) => ReactNode)
    label?: ReactNode | ((command: any) => ReactNode)
    onPopupClose?: () => void
    onPopupOpen?: () => void
    onPreviewBorder?: (border: Partial<Properties> | null) => void
    onQuickClick?: (e: MouseEvent<Element>) => void

    If this set then the popup becomes a split button.

    onSelectBorder?: (border: Partial<Properties> | null) => 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
    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.

    schemeLookup?: SchemeLookup

    For color picker.

    selected?: boolean

    Render as selected,

    selectedBorder?: Partial<Properties>
    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
    showStylingBefore?: boolean
    tooltip?: NonNullable<ReactNode>

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

    variant?: CommandButtonType

    Styling

    CommandButtonType.Toolbar

    Settings
    Member Visibility

    On This Page
    Properties