Search documentation

Search by topic, API name, or import path.

GitHub ↗

Module / v1.0.0-beta.13

@typed/vue/Router

10 unique exports available through this public import path, including their members and aliases.

import * as Router from "@typed/vue/Router";

function

  • provideCurrentRoute

    function

    Public function exposed as provideCurrentRoute from @typed/vue/Router.

  • routeComponent

    function

    Adapt a Vue component to a Typed route handler. Render the full matcher with Typed’s renderer (or the inverse Typed component), keeping route resources alive through SSR.

  • useCurrentPath

    function

    Public function exposed as useCurrentPath from @typed/vue/Router.

  • useCurrentRoute

    function

    Stable structural route mount, distinct from live location.

  • useLocation

    function

    Public function exposed as useLocation from @typed/vue/Router.

  • useMatcher

    function

    Run the actual Typed matcher with Vue scope ownership and typed routing failures.

  • useNavigation

    function

    Live navigation uses the provider’s backend, including BrowserRouter/ServerRouter/TestRouter.

  • useRoute

    function

    Decode under the inherited mount, or a reactive explicit root applied exactly once.

interface

  • RouteOptions

    interface

    Options for decoding a route relative to an explicit or inherited structural mount.

type-alias

  • RouteComponentProps

    type-alias

    Declared route props exclude optional Vue infrastructure props such as ref and key.