@component-controls/react-router-integration
v4.0.5
Published
react-router integration to create stories documentation sites
Readme
Table of contents
In action
Overview
react-router integration plugin for webpack sites documenting your projects with component controls
- Exports list of routes with their components.
- Exports post-build routine to generate sitemaps and search indexes.
API
ControlsPage
function
defined in @component-controls/react-router-integration/integrations/react-router-integration/src/index.tsx
parameters
| Name | Type |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| props* | Omittype: "story" | "blog" | "page" | "tags" | "author" | stringdocId: stringstoryId: stringlastModified: stringdocIndex: booleanquery: stringcategory: stringactiveTab: stringuserData: Record<string, any> |
| returns | FC<>propTypes: WeakValidationMap<> | undefinedcontextTypes: ValidationMap<> | undefineddefaultProps: Partial<P> | undefineddisplayName: string | undefined |
useRoutes
function
defined in @component-controls/react-router-integration/integrations/react-router-integration/src/index.tsx
parameters
| Name | Type |
| --------- | ------------------------ |
| returns | (ReactElement<>)[] |
