router-route

Utility package designed to simplify the process of defining routes in react-router.

router-route takes a custom route map and convert it into a standard route object that can be directly used with react-router's createBrowserRouter API. This package streamlines the management of complex route hierarchies by linking parents and children routes through reference keys, ensuring a clean and organized route structure.

Features

1. Custom Route map: Define your routes using a custom map with parent-child references.

interface Parent extends Omit<RouteObject, "children"> {
  childrenRef?: string | number /** Reference key to children routes*/
}

interface RouteMap {
  parents: Parent[]
  childrens: Record<string | number, RouteMap>
}

2. Automatic Conversion: Effortlessly convert the custom route map into a standard route object for use with createBrowserRouter API.
3. Simplified management: Easily manage and organize complex route hierarchies with reference keys.
4. Recursive Building: Recursively constructs the route tree, linking parent routes to their respective children.

Installation

npm install @ambiere/router-route

Usage

import RouterRoute from "@ambiere/router-route"

const routeMap = {
  parents: [
    {
      element: <RootLayout />,
      errorElement: <RootError />,
      childrenRef: '_rootChildRef'
    },
    /** Support modularization for parents */
    booksRouteModule
  ],

  childrens: {
    "_rootChildRef": { /** Children of RootLayout*/
      parents: [
        {
          path: "/",
          element: <Home />,
        }
      ],
      childrens: { /** Children of RootLayout's children (if any)*/
        /** Support modularization for childrens */
        _accountChildRef: usersRouteModule
      }
    }
  }
}

const routerRoute = new RouterRoute(routeMap)
const routerRouteObject = routerRoute.routeObject()

const router = createBrowserRouter(routerRouteObject, options)

API

RouterRoute(routeMap: RouteMap): RouterRoute

RouterRoute class. Accept routeMap argument, a custom route map containing parents and childrens arrays and returns an instance of RouterRoute containing routeObject method.

routeObject(): RouteObject[]

Converts custom route map into a standard route object and returns a standard route object compatible with react-router's createBrowserRouter API/method.

License

This project is licensed under the MIT License.