If you have any project questions, concerns, or contribution ideas, join our #pwa Slack channel. Find out how to create an account by visiting Community Resources

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 check_box Root URL of the Magento store (including protocol and hostname)
using   Router implementation from React-Router. Possible values: BrowserRouter, HashRouter, MemoryRouter
routerProps   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')
);