AI Disclosure: This page was generated by an LLM and may contain inaccuracies. Hand-crafted documentation will be implemented over time on the road to 1.0

ToolbarPlacementConfig

Since Plugin API: 1.0.0

Toolbar placement configuration (PathBar toolbar).

extends CommandPlacementBase

Signature

interface ToolbarPlacementConfig extends CommandPlacementBase {
    area: "toolbar";
    icon?: string | ((ctx: CommandContext) => string);
    priority?: number;
    fixed?: boolean;
    showLabel?: boolean;
    showArrow?: boolean;
    active?: (ctx: CommandContext) => boolean;
    badgeCount?: (ctx: CommandContext) => number;
    subToolbar?: import("svelte").Component<{
        ctx: ToolbarContext;
    }>;
}

Members

Name	Type	Required	Description
`area`	`"toolbar"`	yes	-
`icon`	`string \| (ctx:CommandContext) => string`	no	Icon override for toolbar display
`priority`	`number`	no	Order priority (higher = more left)
`fixed`	`boolean`	no	If true, cannot be removed by user
`showLabel`	`boolean`	no	Whether to show text label by default (can be overridden by user config)
`showArrow`	`boolean`	no	Whether to show the dropdown chevron on commands with children (default true)
`active`	`(ctx:CommandContext) => boolean`	no	Toggle/active state indicator
`badgeCount`	`(ctx:CommandContext) => number`	no	Optional activity badge count on the path bar button
`subToolbar`	`import("svelte").Component<{ ctx:ToolbarContext}>`	no	Optional sub-toolbar component shown when button is toggled