@resistdesign/voltra
    Preparing search index...

    Type Alias NavigationStateAdapterOptions<TState>

    Options to adapt a navigation state container into a RouteAdapter.

    type NavigationStateAdapterOptions<TState> = {
        getState: () => TState;
        navigate?: (path: string) => void;
        replace?: (path: string) => void;
        subscribe: (listener: () => void) => () => void;
        toPath: (state: TState) => string;
    }

    Type Parameters

    • TState
    Index

    Properties

    getState navigate? replace? subscribe toPath

    Properties

    getState: () => TState

    Return the current navigation state.

    navigate?: (path: string) => void

    Optional navigation handler used for push-style transitions.

    replace?: (path: string) => void

    Optional navigation handler used for replace-style transitions.

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

    Subscribe to navigation state changes.

    toPath: (state: TState) => string

    Convert navigation state into a path string.

    Settings

    Member Visibility

    On This Page

    Properties