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

    Interface CommandToolbarProps

    interface CommandToolbarProps {
        groupKey?: string;
        members?: (string | CommandButtonEntry<any, any> | null)[];
        parentFloat?: FloatReference;
        propsCommandButton?: CommandButtonOptions<any, any, void>;
        ref?: Ref<HTMLDivElement>;
        registry?: ICommandButtonRegistry;
        renderToolbarPalette?: (props: CommandToolbarButtonProps) => ReactNode;
    }

    Hierarchy

    • ToolbarProps
      • CommandToolbarProps
    Index
    groupKey? members? parentFloat? propsCommandButton? ref? registry? renderToolbarPalette?
    groupKey?: string

    Key of a CommandButtonEntry registered in the ICommandButtonRegistry. The toolbar becomes a surface over that panel: its members render (via renderMembers) inside an OverflowPalette. Provide groupKey (registered), members (inline), or renderToolbarPalette (fully custom) - renderToolbarPalette wins when supplied.

    members?: (string | CommandButtonEntry<any, any> | null)[]

    An inline, anonymous member list - the un-registered alternative to groupKey.

    parentFloat?: FloatReference
    propsCommandButton?: CommandButtonOptions<any, any, void>
    ref?: Ref<HTMLDivElement>

    Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

    React Docs

    registry?: ICommandButtonRegistry

    Registry to resolve groupKey from.

    the registry from useCommandButtonRegistry (context or shared singleton).

    renderToolbarPalette?: (props: CommandToolbarButtonProps) => ReactNode

    Fully custom palette renderer (the escape hatch / back-compat). When provided it takes precedence over groupKey / members.

    Settings
    Member Visibility

    On This Page
    Properties