SheetXL - v1.0.2
    Preparing search index...

    Interface InsertScriptCommandButtonProps

    interface InsertScriptCommandButtonProps {
        commandState?: any;
        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;
        outlined?: boolean | OutlineBorder;
        parentFloat?: FloatReference;
        primary?: boolean;
        propsButton?: BoxProps;
        propsPopup?: Partial<ExhibitFloatPanelProps>;
        propsQuickButton?: ExhibitQuickButtonProps;
        quickCommand?: string;
        renderPopupPanel?: RenderSlotFn<ExhibitPopupPanelProps>;
        renderQuickButton?: (props: ExhibitQuickButtonProps) => ReactNode;
        renderTooltip?: (props: ButtonTooltipRenderProps) => ReactNode;
        ripple?: ReactNode;
        scriptPath?: string;
        selected?: boolean;
        showLabel?: boolean;
        tooltip?: NonNullable<ReactNode>;
        variant?: CommandButtonType;
    }

    Hierarchy

    • CommandPopupButtonProps
      • InsertScriptCommandButtonProps
    Index
    commandState? dense? disabled? disableHover? groupKey? icon? label? onPopupClose? onPopupOpen? onQuickClick? outlined? parentFloat? primary? propsButton? propsPopup? propsQuickButton? quickCommand? renderPopupPanel? renderQuickButton? renderTooltip? ripple? scriptPath? selected? showLabel? tooltip? variant?
    commandState?: any

    Optional state for this specific command button.

    to undefined
    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.

    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
    renderPopupPanel?: RenderSlotFn<ExhibitPopupPanelProps>
    renderQuickButton?: (props: ExhibitQuickButtonProps) => ReactNode
    renderTooltip?: (props: ButtonTooltipRenderProps) => ReactNode

    Wrap the button in a custom tooltip.

    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.

    scriptPath?: string

    The script templates to read: a URL that serves templates-scripting/contents.json.

    DEFAULT_SCRIPT_PATH

    selected?: boolean

    Render as selected,

    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?: CommandButtonType

    Styling

    CommandButtonType.Toolbar

    Settings
    Member Visibility

    On This Page
    Properties