A fresh react router designed for flexible route transitions
npm install @cher-ami/router
A fresh high-level react router designed for flexible route transitions
Because managing route transitions with React is always complicated, this router
is designed to allow flexible transitions. It provides Stack component who
render previous and current page component when route change.
This router loads history
, path-to-regexp
and @cher-ami/debug as dependencies.
- example client
- example ssr
- example history block
- Installation
- Simple usage
- Dynamic routes
- Sub Router
- Manage Transitions
- Default sequential transitions
- Custom transitions
- SSR support
- Workflow
- thanks
- credits
API
Components:
- Wrap Link and stack component
- Trig current stack
- Wrap previous and current page
Hooks:
- useRouter Get current router informations like currentRoute and previousRoute
- useLocation Get current location and set new location
- useStack Allow to the parent Stack to handle page transitions and refs
- useRouteCounter Get global history route counter
- useHistory Execute callback each time history changes
- useLang get and set langService current language object
changes
Services:
- LangService Manage :lang params
- Translate Path
Global:
- Helpers Global Routers helpers
- Routers object Global Routers object contains all routers properties (history, instances...)
``shell`
$ npm i @cher-ami/router -s
`jsx
import React from "react"
import { Router, Link, Stack } from "@cher-ami/router"
import { createBrowserHistory } from "history"
const routesList = [
{
path: "/",
component: HomePage,
},
{
path: "/foo",
component: FooPage,
},
]
const history = createBrowserHistory()
function App() {
return (
)
}
`
Page component need to be wrapped by React.forwardRef. The handleRef lets
hold transitions, and ref used by component.
`jsx
import React from "react"
import { useStack } from "@cher-ami/router"
const FooPage = forwardRef((props, handleRef) => {
const componentName = "FooPage"
const rootRef = useRef(null)
// create custom page transitions (example-client with GSAP)
const playIn = () => {
return new Promise((resolve) => {
gsap.from(rootRef.current, { autoAlpha: 0, onComplete: resolve })
})
}
const playOut = () => {
return new Promise((resolve) => {
gsap.to(rootRef.current, { autoAlpha: 0, onComplete: resolve })
})
}
// register page transition properties used by Stack component
useStack({ componentName, handleRef, rootRef, playIn, playOut })
return (
Dynamic routes
cher-ami router use path-to-regexp which
accept path parameters. (check
this documentation).
For example, URL
/blog/my-article will match with this route object:`js
const routesList = [
{
path: "/blog/:id",
component: ArticlePage,
},
]
`You can access route parameters by page component props or by
useRouter() hook.`jsx
import React, { useEffect, forwardRef } from "react"
import { useRoute } from "@cher-ami/router"const ArticlePage = forwardRef((props, handleRef) => {
useEffect(() => {
console.log(props.params) // { id: "my-article" }
}, [props])
// or from any nested components
const { currentRoute } = useRouter()
useEffect(() => {
console.log(currentRoute.props.params) // { id: "my-article" }
}, [currentRoute])
// ...
})
`Also, it is possible to match a specific route by a simple dynamic route
parameter for the "not found route" case. In this case, the routes object order
declaration is important.
/:rest path route need to be the last of
the routesList array.`js
const routesList = [
{
path: "/",
component: HomePage,
},
{
path: "/foo",
component: FooPage,
},
// if "/" and "/foo" doesn't match with the current URL, this route will be rendered
{
path: "/:rest",
component: NotFoundPage,
},
]
`Sub-router
cher-ami router supports nested routes from sub routers instance 🙏🏽.
It is possible to nest as many routers as you want.
1. Define children routes in initial routes list with
children property;`js
const routesList = [
{
path: "/",
component: HomePage,
},
{
path: "/foo",
component: FooPage, // define children routes here
children: [
{
path: "/people",
component: PeoplePage,
},
{
path: "/yolo",
component: YoloPage,
},
],
},
]
`2. Children were defined within the route that render
FooPage component, so
you can then create a new router instance in this component.3. The new subRouter needs his own base and routes list,
getSubRouterBase and getSubRouterRoutes functions are available to get them.`jsx
import React from "react"
import {
Router,
useStack,
Stack,
useRouter,
getPathByRouteName,
getSubRouterBase,
getSubRouterRoutes,
} from "@cher-ami/router"const FooPage = forwardRef((props, handleRef) => {
const router = useRouter()
// Parsed routes list and get path by route name -> "/foo"
const path = getPathByRouteName(router.routes, "FooPage")
// (if last param is false, '/:lang' will be not added) -> "/base/:lang/foo"
const subBase = getSubRouterBase(path, router.base, true)
// get subRoutes
const subRoutes = getSubRouterRoutes(path, router.routes)
return (
)
})
`Manage transitions
ManageTransitions function allows to define, "when" and "in what conditions",
routes transitions will be exectued.$3
By default, a "sequential" transitions senario is used by Stack component: the
previous page play out performs, then the new page play in.
`js
const sequencialTransition = ({ previousPage, currentPage, unmountPreviousPage }) => {
return new Promise(async (resolve) => {
const $current = currentPage?.$element // hide new page
if ($current) $current.style.visibility = "hidden"
// play out and unmount previous page
if (previousPage) {
await previousPage.playOut()
unmountPreviousPage()
}
// wait page isReady promise
await currentPage?.isReadyPromise?.()
// show and play in new page
if (currentPage) {
if ($current) $current.style.visibility = "visible"
await currentPage?.playIn()
}
resolve()
})
}
`$3
It's however possible to create a custom transitions senario function and pass
it to the Stack
manageTransitions props. In this example, we would like to
create a "crossed" route senario: the previous page playOut performs at the same
time than the new page playIn.`jsx
const App = (props, handleRef) => {
const customSenario = ({ previousPage, currentPage, unmountPreviousPage }) => {
return new Promise(async (resolve) => {
// write a custom "crossed" senario...
if (previousPage) previousPage?.playOut()
if (currentPage) await currentPage?.playIn() resolve()
})
}
return (
// ...
)
}
`SSR Support
This router is compatible with SSR due to using
staticLocation props instead of history props on Router instance.
In this case, the router will match only with staticLocation props value and render the appropiate route without invoking the browser history. (Because window is not available on the server).`jsx
routes={routesList}
staticLocation={"/foo"}
// history={createBrowserHistory()}
>
// ...
`In order to use this router on server side, we need to be able to request API on the server side too.
In this case, request will be print as javascript window object on the renderToString html server response.
The client will got this response.
To be able to request on server side (and on client side too),
getStaticProps route property is available:`ts
{
path: "/article/:slug",
component: ArticlePage,
name: "Article",
getStaticProps: async (props, currentLang) => {
// props contains route props and params (ex: slug: "article-1")
const res = await fetch(https://api.com/posts/${currentLang.key}/${props.params.slug});
const api = await res.json();
return { api };
}
}
`Then, get the response data populated in page component props:
`tsx
function HomePage({ api }) {
return {api.title}
}
`For larger example, check the example-ssr folder.
Workflow
`shell
Install dependencies
pnpm ibuild watch
pnpm run build:watchstart tests
pnpm run test:watchstart all examples
pnpm run devBefore publishing
pnpm run pre-publishIncrement version
npm version {patch|minor|major}Publish
npm publish
`API
$3
Router component creates a new router instance.
`jsx
{/ can now use and component /}
`Props:
- routes
TRoute[] Routes list
- base string Base URL - default: "/"
- history BrowserHistory | HashHistory | MemoryHistory _(optional)_ create and set an history - default : BrowserHistory
History mode can
be BROWSER
,
HASH
,
MEMORY
. For more information, check
the history library documentation \
- isHashHistory boolean _(optional)_ default false. If you use HashHistory, you must set isHashHistory to true. ⚠️ Add it to sub-router too
- staticLocation string _(optional)_ use static URL location matching instead of history
- middlewares [] _(optional)_ add routes middleware function to patch each routes)
- id ?number | string _(optional)_ id of the router instance - default : 1$3
Trig new route.
`jsx
`Props:
- to
string | TOpenRouteParams Path ex: /foo or {name: "FooPage" params: { id: bar }}.
"to" props accepts same params than setLocation.
- children ReactNode children link DOM element
- onClick ()=> void _(optional)_ execute callback on the click event
- className string _(optional)_ Class name added to component root DOM element$3
Render previous and current page component.
`jsx
`Props:
- manageTransitions
(T:TManageTransitions) => Promise _(optional)_
This function allows to create the transition scenario. If no props is filled,
a sequential transition will be executed.
- className string _(optional)_ className added to component root DOM
element`ts
type TManageTransitions = {
previousPage: IRouteStack
currentPage: IRouteStack
unmountPreviousPage: () => void
}interface IRouteStack {
componentName: string
playIn: () => Promise
playOut: () => Promise
isReady: boolean
$element: HTMLElement
isReadyPromise: () => Promise
}
`$3
Get current router informations:
`jsx
const router = useRouter()
`Returns:
useRouter() returns an object with these public properties:- currentRoute
TRoute Current route object
- previousRoute TRoute Previous route object
- routeIndex number Current router index
- base string Formated base URL
- setPaused (paused:boolean) => void Paused router instance
- getPaused () => void Get paused state of router instance`ts
// previousRoute and currentRoute
type TRoute = Partial<{
path: string | { [x: string]: string }
component: React.ComponentType
base: string
name: string
parser: Match
props: TRouteProps
children: TRoute[]
url: string
params?: TParams
queryParams?: TQueryParams
hash?: string
getStaticProps: (props: TRouteProps, currentLang: TLanguage) => Promise
_fullUrl: string // full URL who not depends on current instance
_fullPath: string // full Path /base/:lang/foo/second-foo
_langPath: { [x: string]: string } | null
_context: TRoute
}>
`$3
Allow the router to change location.
`jsx
const [location, setLocation] = useLocation()
// give URL
setLocation("/bar")
// or an object
setLocation({ name: "FooPage", params: { id: "2" } })
`Returns:
An array with these properties:
- location
string Get current pathname location
- setLocation (path:string | TOpenRouteParams) => void Open new route`ts
type TOpenRouteParams = {
name: string
params?: TParams
queryParams?: TQueryParams
hash?: string
}
`$3
useStack allows to the parent Stack to handle page transitions and refs.
usage:
`jsx
import React from "react";
import { useStack } from "@cher-ami/router";const FooPage = forwardRef((props, handleRef) => {
const componentName = "FooPage";
const rootRef = useRef(null);
const playIn = () => new Promise((resolve) => { ... });
const playOut = () => new Promise((resolve) => { ... });
// "handleRef" will get properties via useImperativeHandle
useStack({
componentName,
handleRef,
rootRef,
playIn,
playOut
});
return (
{/ ... /}
);
});
`useStack hook can also receive isReady state from the page component. This
state allows for example to wait for fetching data before page playIn function
is executed.`jsx
// ...const [pageIsReady, setPageIsReady] = useState(false)
useEffect(() => {
// simulate data fetching or whatever for 2 seconds
setTimeout(() => {
setPageIsReady(true)
}, 2000)
}, [])
useStack({
componentName,
handleRef,
rootRef,
playIn,
playOut,
// add the state to useStack
// playIn function wait for isReady to change to true
isReady: pageIsReady,
})
// ...
`How does it work?
useStack hook registers isReady state and isReadyPromise
in handleRef.
manageTransitions can now use isReadyPromise in its own thread senario.`js
const customManageTransitions = ({ previousPage, currentPage, unmountPreviousPage }) => {
return new Promise(async (resolve) => {
// ...
// waiting for page "isReady" state to change to continue...
await currentPage?.isReadyPromise?.()
// ...
resolve()
})
}
`Demo codesandbox: wait-is-ready
Parameters:
- componentName
string Name of current component
- handleRef MutableRefObject Ref handled by parent component
- rootRef MutableRefObject Ref on root component element
- playIn () => Promise _(optional)_ Play in transition -
default: new Promise.resolve()
- playOut () => Promise _(optional)_ Play out transition -
default: new Promise.resolve()
- isReady boolean _(optional)_ Is ready state - default: trueReturns:
nothing
$3
Returns route counter
`js
const { routeCounter, isFirstRoute, resetCounter } = useRouteCounter()
`Parameters:
nothing
Returns:
An object with these properties:
- routerCounter
number Current route number - default: 1
- isFirstRoute boolean Check if it's first route - default: true
- resetCounter () => void Reset routerCounter & isFirstRoute states$3
Allow to get the global router history and execute a callback each time history
change.
`js
const history = useHistory((e) => {
// do something
})
`Parameters:
- callback
(event) => void Callback function to execute each time the
history changeReturns:
- history
History : global history object. (Routers.history)$3
Get and update langService current language object.
`tsx
const [lang, setLang] = useLang()
useEffect(() => {
// when current lang change
// it's usefull only if setLang method do not refresh the page.
}, [lang])// set new lang with lang object "key" property value only
setLang("en")
// set new lang with the lang object
setLang({ key: "en" })
`Returns:
Array of :
- lang
TLanguage : current lang object
- setLang (lang: TLanguage | string, force: boolean) => void : set new lang object (same API than langService.setLang)$3
Manage
:lang params from anywhere inside Router scope.
Add isHashHistory to true if you are using createHashHistory() for the router.`jsx
import { LangService } from "@cher-ami/router"
import { Stack } from "./Stack"const base = "/"
// first lang object is default lang
const languages = [{ key: "en" }, { key: "fr" }, { key: "de" }]
// optionally, default lang can be defined explicitly
// const languages = [{ key: "en" }, { key: "fr", default: true }, { key: "de" }];
// Create LangService instance
const langService = new LangService({
languages,
showDefaultLangInUrl: true,
base,
//isHashHistory: true // Optional, only if history is hashHistory
})
; langService={langService}
routes={routesList}
base={base}
//isHashHistory={true} // Optional, only if history is hashHistory
>
`Inside the App
`jsx
function App() {
// get langService instance from router context
const { langService } = useRouter() return (
)
}
`Methods:
#### constructor({ languages: TLanguage[]; showDefaultLangInUrl?: boolean; base?: string; })
voidInitialize LangService by passing it to "langService" Router props
constructor object properties:
-
languages: list on language objects
- showDefaultLangInUrl: choose if default language is visible in URL or not
- base: set the same than router base
- isHashHistory: set to true if hashHistory is used (optional, default false)`jsx
const langService = new LangService({
languages: [{ key: "en" }, { key: "fr" }],
showDefaultLangInUrl: true,
base: "/",
})
`langService instance is available in Router scope from useRouter() hook.`tsx
const Page = () => {
const { langService } = useRouter()
// langService.setLang() ...
}
`#### languages
Tlanguage[]Return languages list
`jsx
const langages = langService.languages
`#### currentLang
TLanguageReturn current Language object.
`jsx
const lang = langService.currentLang
// { key: "..." }
`#### defaultLang
TLanguageReturn default language object
`jsx
const defaultLang = langService.defaultLang
// { key: "..." }
`#### isInit
booleanReturn langService init state
`jsx
const isInit = langService.isInit
`#### isHashHistory
booleanReturn isHashHistory state.
`jsx
const isHashHistory = langService.isHashHistory
// true | false
`#### setLang(toLang: TLanguage, forcePageReload = true)
voidSwitch to another available language. This method can be called in nested router
component only.
-
forcePageReload: choose if we reload the full application or using the
internal router stack to change the language`jsx
langService.setLang({ key: "de" })
`#### redirectToDefaultLang(forcePageReload = true)
voidIf URL is
/, showDefaultLangInUrl is set to true and default lang is 'en',
it will redirect to /en.-
forcePageReload: choose if we reload the full application or using the
internal router stack to change the language`js
langService.redirectToDefaultLang()
`#### redirectToBrowserLang(forcePageReload = true)
voidSame than
redirectToDefaultLang method but redirect to the user navigator.language.
If the browser language doesn't exist in Languages array, we redirect to the default lang.`js
langService.redirectToBrowserLang()
`$3
Paths can be translated by lang in route path property. This option works only if LangService instance is created and passed to the Router component.
`js
{
path: { en: "/foo", fr: "/foo-fr", de: "/foo-de" },
component: FooPage,
}
`Helpers
#### createUrl()
(args: string | TOpenRouteParams, base?:string, allRoutes?: TRoute[]) => stringCreate a formated URL by string, or
TOpenRouteParams#### openRoute()
(args: string | TOpenRouteParams, history?) => voidPush new route in current history. Stack(s) component(s) will return the appriopriate route.
Routers
Routers is a global object who contains all routers informations. Because @cher-ami/router is possibly multi-stack, we need a global object to store shared informations between router instances.
#### Routers.routes
TRoute[]Final routes array used by the router be
#### Routers.history
HashHistory | MemoryHistory | BrowserHistorySelected history mode. all history API is avaible from this one.
#### Routers.isHashHistory
booleanReturn the value set on the Router component
#### Routers.langService
LangServiceLangService instance given to the first Router component.
#### Routers.routeCounter
numberHow many route are resolved from the start of the session. This property is also available from
useRouteCounter.#### Routers.isFirstRoute
booleanIs it the first route of the session. This property is also available from
useRouteCounter`.cher-ami router API is inspired by wouter,
solidify router
and
vue router API.