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

    Interface PatternPopupButtonProps

    interface PatternPopupButtonProps {
        background?: Serializable | null;
        createCell: (update: Update) => ICell | null;
        createTooltip?: (props: TooltipProps, disabled: boolean) => Element;
        darkMode?: boolean;
        disabled?: boolean;
        foreground?: Serializable | null;
        label?: ReactNode;
        onPopupClose?: () => void;
        onPopupOpen?: () => void;
        onQuickClick?: (e: MouseEvent<Element>) => void;
        onSelectPattern?: (pattern: BuiltInSheetPattern) => void;
        parentFloat?: FloatReference;
        primary?: boolean;
        propsPopup?: Partial<ExhibitFloatPanelProps>;
        propsQuickButton?: ExhibitQuickButtonProps;
        renderQuickButton?: (props: ExhibitQuickButtonProps) => ReactNode;
        ripple?: ReactNode;
        selected?: boolean;
        selectedPattern: BuiltInSheetPattern;
        showLabel?: boolean;
        tooltip?: NonNullable<ReactNode>;
    }

    Hierarchy

    • Omit<ExhibitPopupButtonProps, "icon" | "createPopupPanel">
      • PatternPopupButtonProps
    Index
    background? createCell createTooltip? darkMode? disabled? foreground? label? onPopupClose? onPopupOpen? onQuickClick? onSelectPattern? parentFloat? primary? propsPopup? propsQuickButton? renderQuickButton? ripple? selected? selectedPattern showLabel? tooltip?
    background?: Serializable | null

    The color behind the marks.

    createCell: (update: Update) => ICell | null
    createTooltip?: (props: TooltipProps, disabled: boolean) => Element

    Allows for custom tooltip creation

    darkMode?: boolean
    disabled?: boolean
    foreground?: Serializable | null

    The tile's mark color, so the gallery previews the pattern the user will actually get.

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

    If this set then the popup becomes a split button.

    onSelectPattern?: (pattern: BuiltInSheetPattern) => void
    parentFloat?: FloatReference
    primary?: boolean

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

    false
    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.

    selected?: boolean

    Render as selected,

    selectedPattern: BuiltInSheetPattern

    The currently applied tile.

    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.

    Settings
    Member Visibility

    On This Page
    Properties