Document routes API

packages/registry/docs/conf.py

@@ -60,6 +60,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
     "sphinx_copybutton",
+    "sphinx_togglebutton",  # Toggle admonitions in @plone/registry
     "sphinxext.opengraph",
 ]
 

packages/registry/docs/how-to-guides/instantiate-registry.md

@@ -46,6 +46,7 @@ export type ConfigData = {
   widgets: WidgetsConfig | Record<string, never>;
   addonReducers?: AddonReducersConfig;
   addonRoutes?: AddonRoutesConfig;
+  routes?: Array<ReactRouterRouteEntry>;
   slots: SlotsConfig | Record<string, never>;
   components: ComponentsConfig | Record<string, never>;
   utilities: UtilitiesConfig | Record<string, never>;

packages/registry/docs/how-to-guides/register-routes.md

@@ -0,0 +1,54 @@
+---
+myst:
+  html_meta:
+    "description": "How to register new routes in @plone/registry"
+    "property=og:description": "How to register new routes in @plone/registry"
+    "property=og:title": "How to register new routes in @plone/registry"
+    "keywords": "Volto, Plone, frontend, React, configuration, routes, React Router"
+---
+
+# Register new routes
+
+The `config.registerRoute` method adds a route to the configuration registry.
+It saves the routes in the `config.routes` key in the configuration object.
+You should provide one route at a time and must have the following shape:
+
+```ts
+type ReactRouterRouteEntry = {
+  type: 'route' | 'index' | 'layout' | 'prefix';
+  path: string;
+  file: string;
+  options?: {
+    id?: string;
+    index?: boolean;
+    caseSensitive?: boolean;
+  };
+  children?: ReactRouterRouteEntry[];
+};
+```
+
+The `type`, `path`, and `file` are mandatory.
+The `type` key specifies the route type to create, specifically one of `route`, `index`, `layout`, or `prefix`.
+The type `route` can contain nested routes.
+
+```{info}
+The routes registered with this method are intended to be React Router 7 compliant routes.
+They are meant to be loaded via a helper provided by `@plone/react-router` in an existing React Router 7 app.
+Check the official [React Router 7 documentation](https://reactrouter.com/start/framework/routing) for more information on how to define React Router 7 routes.
+```
+
+Register a route as shown in the following example.
+
+```ts
+config.registerRoute({
+  type: 'route',
+  path: '/login',
+  file: '@plone/cmsui/components/login.tsx',
+  options: {
+    id: 'login',
+    index: true,
+  },
+});
+```
+
+You must set the module's full path name of the registered route component to make `@plone/registry` correctly address it.

packages/registry/docs/index.md

@@ -4,7 +4,7 @@ myst:
     "description": "@plone/registry provides support for building an add-on and configuration registry with infrastructure for JavaScript and TypeScript-based apps."
     "property=og:description": "@plone/registry provides support for building an add-on and configuration registry with infrastructure for JavaScript and TypeScript-based apps."
     "property=og:title": "@plone/registry"
-    "keywords": "@plone/registry, registry, add-on, configuration, component, utility, JavaScript, TypeScript, app"
+    "keywords": "@plone/registry, registry, add-on, configuration, component, routes, React Router, utility, JavaScript, TypeScript, app"
 ---
 
 # `@plone/registry`
@@ -29,6 +29,7 @@ how-to-guides/access-registry
 how-to-guides/register-and-retrieve-components
 how-to-guides/register-and-retrieve-utilities
 how-to-guides/shadow-a-component
+how-to-guides/register-routes
 ```
 
 

packages/registry/news/6604.documentation

@@ -0,0 +1 @@
+Document the route API. @sneridagh

requirements-docs.txt

@@ -5,6 +5,7 @@ plone-sphinx-theme
 sphinx-autobuild
 sphinx-copybutton
 sphinx-examples
+sphinx-togglebutton
 sphinxcontrib-video
 sphinxcontrib-youtube
 sphinxext-opengraph