Broadleaf Microservices

Routes

Table of Contents

This document covers routing within the client-side admin application; how they work, and how they can be changed. Internally, the admin application uses React Router for rendering the routes with various methods of defining routes whether through metadata or statically.

Metadata Routes

Metadata-driven routes are the most common way of defining and managing routes in the admin application. These type of routes are defined within the metadata service, and are loaded and cached by admin application on page load.

To learn more about metadata routes, see the Metadata Routes documentation.

Static Routes

Static routes are useful in certain scenarios where metadata-driven functionality is not needed. A static route can be defined at the root of the application by rendering additional routes as children of the AdminApp, for example:

<AdminApp>
  <Route path="/my-custom-route">
    {routeProps => {
      // render your component
    }}
  </Route>
</AdminApp>