@resistdesign/voltra
    Preparing search index...

    Type Alias RouteAdapter

    Platform adapter that supplies the current path and change notifications.

    type RouteAdapter = {
        back?: () => void;
        canGoBack?: () => boolean;
        getPath: () => string;
        push?: (path: string, title?: string) => void;
        replace?: (path: string, title?: string) => void;
        subscribe: (listener: (path: string) => void) => () => void;
    }
    Index

    Properties

    back? canGoBack? getPath push? replace? subscribe

    Properties

    back?: () => void

    Optional navigation helper for adapters that can go backward.

    canGoBack?: () => boolean

    Optional capability check for backward navigation.

    getPath: () => string

    Read the current path.

    push?: (path: string, title?: string) => void

    Optional navigation helper for adapters that can push state.

    push/replace paths are normalized through shared routing utils: absolute (/x), relative (x, ./x, ../x), and empty ("" => /).

    replace?: (path: string, title?: string) => void

    Optional navigation helper for adapters that can replace state.

    subscribe: (listener: (path: string) => void) => () => void

    Subscribe to path changes.

    Settings

    Member Visibility

    On This Page

    Properties