Phials developer documentation
User guide
AI Notice: Most documentation right now was auto-generated by an LLM. Handwritten documentation will be implemented over time on the road to 1.0

ToolbarButtonProvider

Toolbar button provider - contributes buttons to the PathBar toolbar

Signature

interface ToolbarButtonProvider {
    type: "toolbar";
    id: string;
    name: string;
    priority?: number;
    extensions?: string[];
    mimeTypes?: string[];
    categories?: FileCategory[];
    requiresSelection?: boolean;
    button: ToolbarButtonDefinition | ToolbarButtonGroupDefinition | ToolbarButtonDropdownDefinition;
    subToolbar?: import("svelte").Component<ToolbarSubToolbarProps>;
}

Members

NameTypeRequiredDescription
type"toolbar"yes
idstringyes
namestringyes
prioritynumberno
extensionsstring[]noOptional file-type filtering (shows only when matching files selected)
mimeTypesstring[]no
categoriesFileCategory[]no
requiresSelectionbooleanno
buttonToolbarButtonDefinition | ToolbarButtonGroupDefinition | ToolbarButtonDropdownDefinitionyesButton definition
subToolbarimport("svelte").Component<ToolbarSubToolbarProps>noOptional sub-toolbar (custom component shown when button is clicked)