Router

The Peregrine Router is a client-side router that is designed to understand the different storefront routes within Magento 2. If using Peregrine to bootstrap your PWA, it is configured automatically. If not, the Router can be manually consumed.

Props

Name	Required	Description
`apiBase`	Yes	Root URL of the Magento store (including protocol and hostname)
`using`	No	Router implementation from React-Router. Possible values: `BrowserRouter`, `HashRouter`, `MemoryRouter`
`routerProps`	No	Any additional props to pass to React-Router

Example

The following example shows the manual usage of the Router component:

import ReactDOM from "react-dom";
import { Router } from "@magento/peregrine";

ReactDOM.render(
  <Router apiBase="https://mystore.com" />,
  document.querySelector("main")
);
Copied to your clipboard
import ReactDOM from "react-dom";
import { Router } from "@magento/peregrine";

ReactDOM.render(
  <Router apiBase="https://mystore.com" />,
  document.querySelector("main")
);

List

Custom React hooks

Last updated 9/13/2023

Was this helpful?

Yes

Router

Props.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Example

Props