README.md

Minimum viable replacement of react-router for apps using react-redux.

Usage

npm add 'github:sensedata/minimum-router'

Setup Redux reduction at router: and store @@minimum-router/navigate actions' props and path.

import {combineReducers} from "redux"
import * as MinimumRouter from "@minimum/router"

const reducer = combineReducers({
    router: MinimumRouter.reducer,
    [...]
})

Routes

The simplest use is paths with elements.

import {Routes, Route} from "@minimum/router"

return (
  <Routes>
    <Route path="/foo" element={<Foo/>}/>
    <Route path="/bar" element={<Bar/>}/>
  </Routes>
)

Navigate

To navigate, dispatch() an action.

import {useDispatch} from "react-redux"

const dispatch = useDispatch()
dispatch({type: "@@minimum-router/navigate", path: "/foo"})

Props

Or create the action using the navigate helper.

import {useDispatch} from "react-redux"
import {navigate} from "@minimum/router"

const dispatch = useDispatch()
dispatch(navigate("/foo"))

You can include props in your element or in the action or both.

import {Routes, Route} from "@minimum/router"

return (
  <Routes>
    <Route path="/foo" element={<Foo/>}/>
    <Route path="/bar" element={<Bar bar1="baz1"/>}/>
  </Routes>
)

import {useDispatch} from "react-redux"

const dispatch = useDispatch()
dispatch({type: "@@minimum-router/navigate", path: "/foo", props: {bar2: "baz2"}})

Or use navigate(path, props)

import {useDispatch} from "react-redux"
import {navigate} from "@minimum/router"

const dispatch = useDispatch()
dispatch(navigate("/foo", {bar2: "baz2"}))

Fallback

* is a special path that will match only if <Routes/> matches no other <Route path/>.

import {Routes, Route} from "@minimum/router"

return (
  <Routes>
    <Route path="/foo" element={<Foo/>}/>
    <Route path="/bar" element={<Bar/>}/>
    <Route path="*" element={<Baz/>}/>
  </Routes>
)

Error Boundary

Optionally provide a React error boundary that will wrap each Route's element. To allow an error boundary to render without breaking routing.

import {Routes, Route} from "@minimum/router"
import {MyErrorBoundary} from "./my_error_boundary.jsx"

return (
  <Routes errorBoundary={MyErrorBoundary}>
    <Route path="/foo" element={<Foo/>}/>
    <Route path="/bar" element={<Bar/>}/>
    <Route path="*" element={<Baz/>}/>
  </Routes>
)

Details

• <Routes/> will match the first <Route path/> with the most left to right segment matches.
• The <Routes/> element uses React.cloneElement on the <Route element/> of the match.

Invalid States

Typically invalid states will render an empty <div> with the CSS class "minimum-router" and:

• no-routes when the <Routes> element has no child <Route> elements.
• no-router-path with no-fallback when the Redux state.router.path is falsy and the routes have no fallback path, i.e., no <Route path="*" ...>.
• no-route-match with no-fallback when the Redux state.router.path scores zero against all <Route> elements and the routes include no fallback path, i.e., no <Route path="*" ...>.