README
🚃
cher-ami router
A fresh react router designed for flexible route transitions
cher-ami router API is inspired by wouter, solidify router and vue router API. This repository started from a copy of willybrauner/react-router.
Why another react router?
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 @wbe/debug as dependencies.
Summary
API
Components:
<Router />
Wrap Link and stack component<Link />
Trig current stack<Stack />
Wrap previous and current page
Hooks:
useRouter
Get current router informations like currentRoute and previousRouteuseLocation
Get current location and set new locationuseStack
Allow to the parent Stack to handle page transitions and refsuseRouteCounter
Get global history route counteruseHistory
Execute callback each time history changesuseLang
get and set langService current language object changes
Services:
LangService
Manage:lang
paramsTranslate Path
Global:
Helpers
Global Routers helpersRouters object
Global Routers object contains all routers properties (history, instances...)
Installation
$ npm i @cher-ami/router -s
Simple usage
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 (
<Router routes={routesList} history={history} base={"/"}>
<nav>
<Link to={"/"} />
<Link to={"/foo"} />
</nav>
<Stack />
</Router>
);
}
Page component need to be wrapped by React.forwardRef
. The handleRef
lets
hold transitions, and ref used by <Stack />
component.
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 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 (
<div className={componentName} ref={rootRef}>
{componentName}
</div>
);
});
Demo codesandbox: simple usage
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:
const routesList = [
{
path: "/blog/:id",
component: ArticlePage,
},
];
You can access route parameters by page component props or by useRouter()
hook.
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]);
// ...
});
Demo codesandbox: simple usage
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.
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,
},
];
Demo codesandbox: not found route
Sub-router
cher-ami router supports nested routes from sub routers instance 🙏🏽. It is possible to nest as many routers as you want.
- Define children routes in initial routes list with
children
property;
const routesList = [
{
path: "/",
component: HomePage,
},
{
path: "/foo",
component: FooPage,
// define children routes here
children: [
{
path: "/people",
component: PeoplePage,
},
{
path: "/yolo",
component: YoloPage,
},
],
},
];
Children were defined within the route that render
FooPage
component, so you can then create a new router instance in this component.The new subRouter needs his own base and routes list,
getSubRouterBase
andgetSubRouterRoutes
functions are available to get them.
import React from "react";
import {
Router,
useStack,
Stack,
useRouter,
getPathByRouteName,
getSubRouterBase,
getSubRouterRoutes,
} from "@cher-ami/router";
const FooPage = forwardRef((props, handleRef) => {
// Get parent router context
const { base, routes } = useRouter();
// Parsed routes list and get path by route name
const path = getPathByRouteName(routesList, "FooPage"); // "/foo"
// ...
return (
<div>
<Router
// -> "/base/:lang/foo" (if last param is false, ':lang' will be not added)
base={getSubRouterBase(path, base, true)}
// children routes array of FooPage
routes={getSubRouterRoutes(path, routes)}
>
<Stack />
</Router>
</div>
);
});
Manage transitions
ManageTransitions
function allows to define, "when" and "in what conditions",
routes transitions will be exectued.
Default sequential transitions
By default, a "sequential" transitions senario is used by Stack component: the previous page play out performs, then the new page play in.
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();
});
};
Custom transitions
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.
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 (
// ...
<Stack manageTransitions={customSenario} />
);
};
Demo codesandbox: custom manage transitions
Debug
@wbe/debug is used on this project. It allows to easily get logs informations on development and production modes.
To use it, add this line in your browser console:
localStorage.debug = "router:*"
Example
A use case example is available on this repos.
Install dependencies
$ npm i
Start dev server
$ npm run dev
API
Router
Router component creates a new router instance.
<Router routes={} base={} history={} middlewares={} id={}>
{/* can now use <Link /> and <Stack /> component */}
</Router>
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 - middlewares
[]
add routes middleware function to patch each routes) - id
?number | string
Link
Trig new route.
<Link to={} className={} />
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
Stack
Render previous and current page component.
<Stack manageTransitions={} className={} />
Props:
- manageTransitions
(T:TManageTransitions) => Promise<void>
(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
type TManageTransitions = {
previousPage: IRouteStack;
currentPage: IRouteStack;
unmountPreviousPage: () => void;
};
interface IRouteStack {
componentName: string;
playIn: () => Promise<any>;
playOut: () => Promise<any>;
isReady: boolean;
$element: HTMLElement;
isReadyPromise: () => Promise<void>;
}
useRouter
Get current router informations:
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
// previousRoute and currentRoute
type TRoute = {
path: string;
component: React.ComponentType<any>;
props?: { [x: string]: any };
parser?: Path;
children?: TRoute[];
matchUrl?: string;
fullUrl?: string;
};
useLocation
Allow the router to change location.
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
type TOpenRouteParams = {
name: string;
params?: { [x: string]: any };
};
useStack
useStack allows to the parent Stack to handle page transitions and refs.
usage:
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 (
<div className={componentName} ref={rootRef}>
{/* ... */}
</div>
);
});
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.
// ...
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.
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<any>
Ref handled by parent component - rootRef
MutableRefObject<any>
Ref on root component element - playIn
() => Promise<any>
(optional) Play in transition - default:new Promise.resolve()
- playOut
() => Promise<any>
(optional) Play out transition - default:new Promise.resolve()
- isReady
boolean
(optional) Is ready state - default:true
Returns:
nothing
useRouteCounter
Returns route counter
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
useHistory
Allow to get the global router history and execute a callback each time history change.
const history = useHistory((e) => {
// do something
});
Parameters:
- callback
(event) => void
Callback function to execute each time the history change
Returns:
- history
location[]
: global history object. (Routers.history
)
useLang
Get and update langService current language object.
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 thanlangService.setLang
)
LangService
Manage :lang
params from anywhere inside Router scope.
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,
});
<Router langService={langService} routes={routesList} base={base}>
<App />
</Router>;
Inside the App
function App() {
// get langService instance from router context
const { langService } = useRouter();
return (
<div>
<button onClick={() => langService.setLang({ key: "de" })}>
switch to "de" lang
</button>
<nav>
{/* will return /de */}
<Link to={"/"} />
{/* will return /de/foo */}
<Link to={"/foo"} />
</nav>
<Stack />
</div>
);
}
Methods:
[]; showDefaultLangInUrl?: boolean; base?: string; }) void
constructor({ languages: TLanguagevoid
Initialize LangService by passing it to "langService" Router props
constructor object properties:
languages
: list on language objectsshowDefaultLangInUrl
: choose if default language is visible in URL or notbase
: set the same than router base
const langService = new LangService({
languages: [{ key: "en" }, { key: "fr" }],
showDefaultLangInUrl: true,
base: "/",
});
langService
instance is available in Router scope from useRouter()
hook.
const Page = () => {
const { langService } = useRouter();
// langService.setLang() ...
};
Tlanguage[]
languages Return languages list
const langages = langService.languages;
TLanguage
currentLang Return current Language object.
const lang = langService.currentLang;
// { key: "..." }
TLanguage
defaultLang Return default language object
const defaultLang = langService.defaultLang;
// { key: "..." }
boolean
isInit Return langService init state
const isInit = langService.isInit;
void
setLang(toLang: TLanguage, forcePageReload = true) Switch 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
langService.setLang({ key: "de" });
void
redirect(forcePageReload = true) If URL is /
, showDefaultLangInUrl
is set to true
and default lang is 'en',
it will redirect to /en
. 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
langService.redirect();
Translate Path
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.
{
path: { en: "/foo", fr: "/foo-fr", de: "/foo-de" },
component: FooPage,
}
Helpers
createUrl()
(args: string | TOpenRouteParams, base?:string, allRoutes?: TRoute[]) => string
Create a formated URL by string, or TOpenRouteParams
openRoute()
(args: string | TOpenRouteParams, history?) => void
Push 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 | BrowserHistory
Selected history mode. all history API is avaible from this one.
Routers.langService
LangService
LangService instance given to the first Router component.
Routers.routeCounter
number
How many route are resolved from the start of the session. This property is also available from useRouteCounter
.
Routers.isFirstRoute
boolean
Is it the first route of the session. This property is also available from useRouteCounter
.