Blockbench Reference Docs
    Preparing search index...

    Interface PanelOptions

    interface PanelOptions {
        component?: Component;
        condition?: any;
        default_position?: Partial<PanelPositionData>;
        default_side?: "right" | "left";
        display_condition?: any;
        expand_button?: boolean;
        form?: InputForm;
        growable?: boolean;
        icon: string;
        id?: string;
        insert_after?: string;
        insert_before?: string;
        menu?: any;
        min_height?: number;
        mode_positions?: Record<string, Partial<PanelPositionData>>;
        name?: string;
        optional?: boolean;
        plugin?: string;
        resizable?: true;
        selection_only?: boolean;
        toolbars?: { [id: string]: Toolbar } | Toolbar[];
        onFold?(): void;
        onResize?(): void;
    }
    Index

    Properties

    component? condition? default_position? default_side? display_condition? expand_button? form? growable? icon id? insert_after? insert_before? menu? min_height? mode_positions? name? optional? plugin? resizable? selection_only? toolbars?

    Methods

    onFold? onResize?

    Properties

    component?: Component
    condition?: any
    default_position?: Partial<PanelPositionData>
    default_side?: "right" | "left"
    display_condition?: any
    expand_button?: boolean

    Adds a button to the panel that allows users to pop-out and expand the panel on click

    form?: InputForm
    growable?: boolean

    If true, the panel can automatically become smaller or larger than its initial size in the sidebar

    icon: string
    id?: string
    insert_after?: string

    Identifier of another panel to insert this one below

    insert_before?: string

    Identifier of another panel to insert this one above

    menu?: any
    min_height?: number
    mode_positions?: Record<string, Partial<PanelPositionData>>
    name?: string
    optional?: boolean
    plugin?: string
    resizable?: true

    When true, the height of the panel can be adjusted in the sidebar

    selection_only?: boolean
    toolbars?: { [id: string]: Toolbar } | Toolbar[]

    Methods

    • Returns void

    • Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods