Type Route

Type Route

  • Docs
  • GitHub
  • v0.6.0

›<Router>

Introduction

  • Getting Started
  • Simple React Example

Guides

  • Code Splitting
  • Complex Route Parameters
  • Custom Link Behavior
  • Custom Query String
  • Data Fetching
  • Nested and Similar Routes
  • No Match (404)
  • Page Layout
  • Preventing Navigation
  • Programmatic Navigation
  • Redirects
  • Rendering Links
  • Route Parameters
  • Scroll Restoration
  • Server Side Rendering
  • Styling of Links for the Currently Active Route
  • Type Route without React
  • Wildcard Routes
  • Previous Release Docs
  • Guide Missing?

API Reference

    <ParameterDefinition>

    • param

    <RouteDefinition>

    • defineRoute
    • extend

    <RouteGroup>

    • createGroup
    • has

    <Route>

    • action
    • href
    • link
    • name
    • params
    • push
    • replace

    <Router>

    • createRouter
    • useRoute
    • RouteProvider
    • routes
    • session

    Types

    • Link
    • QueryStringSerializer
    • Route
    • RouterOpts
    • SessionOpts
    • ValueSerializer

    Miscellaneous

    • noMatch
    • preventDefaultLinkClickBehavior
Edit

useRoute

const { RouteProvider, useRoute } = createRouter({ ... });

ReactDOM.render(<RouteProvider><App/></RouteProvider>, document.querySelector("#main"));

function App() {
  const route = useRoute();

  return <div>
    {route.name}
  </div>;
}

The useRoute hook returns the current route. You need to wrap your application in a RouteProvider in order to use this hook.

← createRouterRouteProvider →
Type Route is a Type Hero project  ·  Copyright © 2020