Phials plugin documentation
User guide
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

PluginPaneNavigation

Since Plugin API: 1.0.0

Signature

interface PluginPaneNavigation {
    readonly currentPath: string | null;
    readonly canGoBack: boolean;
    readonly canGoForward: boolean;
    readonly canGoUp: boolean;
    navigateTo(path: string): Promise<void>;
    openPath(path: string): Promise<void>;
    back(): Promise<void>;
    forward(): Promise<void>;
    up(): Promise<void>;
}

Members

NameTypeRequiredDescription
currentPathstring | nullyes-
canGoBackbooleanyes-
canGoForwardbooleanyes-
canGoUpbooleanyes-
navigateTo(path: string) => Promise<void>yes-
openPath(path: string) => Promise<void>yes-
back() => Promise<void>yes-
forward() => Promise<void>yes-
up() => Promise<void>yes-