@component-controls/routes NPM

Overview

Route-related utility functions for component-controls

Installation

This package is usually installed as part of the @component-controls package, but you can also install it standalone:

$ npm install @component-controls/routes --save-dev

HomePageInfo

interface

defined in @component-controls/routes/core/routes/src/routes/index-page.ts

properties

Name	Type
`type`	`string`
`docId`	`string`
`storyId`	`string`
`path*`	`string`
`lastModified`	`string`

getSiteMap

react function

defined in @component-controls/routes/core/routes/src/sitemap/sitemap.ts

parameters

Name	Type	Description
`store`	`Storeerror`: `stringconfig``title`: `stringlogo`: `string` \| `ReactNodeapppropTypes`: `contextTypes`: `defaultProps`: `displayName`: `description`: `stringcopyright`: `stringlanguage`: `stringauthor`: `stringimage`: `stringlinks`: (`DetailedHTMLProps`<>)[]`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefinedpages`[`string`]: `theme`[`string`]: `anystorySort`: function* (`a`: `stringb`: `string`) => `numbertoolbarleft`: `right`: `footerleft`: `right`: `sidebar`: `ActionItem`[]`menu`: `StaticMenuItem`[]`components`: `Record`<`string`, `unknown`>`analytics`: `anycomponent`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`[`string`]: `ComponentControl`<`P`>`smartControlssmart`: `include`: `exclude`: `decorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `stringrenderFn`: function* (`props``story`: `doc`: `values`: `options`: ) => `anywebpack`: `Configuration` \| `WebpackConfigFnfinalWebpack`: `Configuration` \| `WebpackConfigFnpresets`: `RuleType`[]`configPath`: `stringdistFolder`: `stringbundleName`: `stringstaticFolder`: `stringcssFileName`: `stringlogOptions`: `Partial`<`LogOptions`>`mode`: `"none"` \| `"development"` \| `"production"loadersat`: `module`: `ident`: `loader`: `options`: `stories`: `string` \| `string`[]`files`: `string` \| `string`[]`siteRoot`: `stringignore`: `string`[]`categories`: `DocType`[]`siteMap`: `type` \| `booleansiteUrl`: `stringinstrument`: `anysearchindexingModule`: `searchingModule`: `fields`: `emptySearchDocuments`: `hitsPerPage`: `options`: `tokensfigmaAccessToken`: `githubAccessToken`: `docs`[`string`]: `type`[`string`]: `anytitle`: `stringtype`: DocType`route`: `stringdate`: `stringdateModified`: `stringstatus`: `"draft"` \| `"published"tags`: `string`[]`keywords`: `string`[]`description`: `string` \| `JSX.Elementimage`: `stringauthor`: `stringorder`: `numbermenu`: `stringtemplatebind`: `description`: `component`: `subcomponents`: `smartControls`: `decorators`: `plugins`: `category`: `source`: `storyName`: `id`: `rawId`: `doc`: `storyFn`: `loc`: `subtitle`: `dynamic`: `dynamicId`: `controls`: `stories`: `string`[]`source`: `stringfileName`: `stringpackage`: `stringtestFiles`: `string`[]`testCoverage`: `string`[]`testData`: `stringrenderFn`: FrameworkRenderFn`data`: DocumentData`componentsLookup`[`string`]: `stringMDXPage`: `anyisMDXComponent`: `booleanparameters`: `anycomponentat`: `subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`: ComponentControls`smartControls`: SmartControls`decorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `stringnavSidebar`: `booleancontextSidebar`: `booleanfullPage`: `booleanstories`[`string`]: `typename`: `stringstoryName`: `stringid`: `stringrawId`: `stringdoc`: `stringstoryFn`: StoryRenderFn`description`: `stringarguments`: StoryArguments`loc`: CodeLocation`source`: `stringsubtitle`: `stringdynamic`: `booleandynamicId`: `stringcomponentat`: `subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`: ComponentControls`smartControls`: SmartControls`decorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `stringcomponents`[`string`]: `interfacename`: `stringimportedName`: `"default"` \| `"namespace"` \| `stringfrom`: `stringrequest`: `stringfileName`: `stringpropsInfoFile`: `stringloc`: CodeLocation`package`: `stringsource`: `stringinfo`: ComponentInfo`externalDependencies`: Imports`localDependencies`: Imports`jsx`: JSXTree`fileInfo`: FileInfo`jest`: JestTests`packages`[`string`]: `interfacefileHash`: `stringname`: `stringversion`: `stringdependencies`: PackageDependencies`devDependencies`: PackageDependencies`peerDependencies`: PackageDependencies`privateNpm`: `booleanrepository``browse`: `docs`: `issues`: `addObserver`: function (`observer`: function* (`story`: Story) => `void`) => `voidremoveObserver`: function* (`observer`: function* (`story`: Story) => `void`) => `voidupdateStory`: function* (`story``name`: `stringstoryName`: `stringid`: `stringrawId`: `stringdoc`: `stringstoryFn`: StoryRenderFn`description`: `stringarguments`: StoryArguments`loc`: CodeLocation`source`: `stringsubtitle`: `stringdynamic`: `booleandynamicId`: `stringcomponent`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`: ComponentControls`smartControls`: SmartControls`decorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `string`) => `voidsearch`: function (`store``error`: `config`: `docs`: `stories`: `components`: `packages`: `addObserver`: `removeObserver`: `updateStory`: `search`: ) => `SearchResultitems`: `SearchItem`[]`searchFn`: function* (`search`: ) => `voidproviderlogo`: `url`: `name`:	Store of stories information in memory after the loader is applied
`returns`	`string`

DocHomePagesPath

interface

defined in @component-controls/routes/core/routes/src/routes/docs-index-pages.ts

properties

Name	Type
`type`	`"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string`
`path*`	`string`
`docId`	`string`
`storyId`	`string`
`lastModified`	`string`
`docIndex`	`boolean`

getIndexPage

function

defined in @component-controls/routes/core/routes/src/routes/index-page.ts

parameters

Name	Type	Description
`store`	`Storeerror`: `stringconfig``title`: `stringlogo`: `string` \| `ReactNodeapppropTypes`: `contextTypes`: `defaultProps`: `displayName`: `description`: `stringcopyright`: `stringlanguage`: `stringauthor`: `stringimage`: `stringlinks`: (`DetailedHTMLProps`<>)[]`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefinedpages`[`string`]: `theme`[`string`]: `anystorySort`: function* (`a`: `stringb`: `string`) => `numbertoolbarleft`: `right`: `footerleft`: `right`: `sidebar`: `ActionItem`[]`menu`: `StaticMenuItem`[]`components`: `Record`<`string`, `unknown`>`analytics`: `anycomponent`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`[`string`]: `ComponentControl`<`P`>`smartControlssmart`: `include`: `exclude`: `decorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `stringrenderFn`: function* (`props``story`: `doc`: `values`: `options`: ) => `anywebpack`: `Configuration` \| `WebpackConfigFnfinalWebpack`: `Configuration` \| `WebpackConfigFnpresets`: `RuleType`[]`configPath`: `stringdistFolder`: `stringbundleName`: `stringstaticFolder`: `stringcssFileName`: `stringlogOptions`: `Partial`<`LogOptions`>`mode`: `"none"` \| `"development"` \| `"production"loadersat`: `module`: `stories`: `string` \| `string`[]`files`: `string` \| `string`[]`siteRoot`: `stringignore`: `string`[]`categories`: `DocType`[]`siteMap`: `type` \| `booleansiteUrl`: `stringinstrument`: `anysearchindexingModule`: `searchingModule`: `fields`: `emptySearchDocuments`: `hitsPerPage`: `options`: `tokensfigmaAccessToken`: `githubAccessToken`: `docs`[`string`]: `type`[`string`]: `anytitle`: `stringtype`: DocType`route`: `stringdate`: `stringdateModified`: `stringstatus`: `"draft"` \| `"published"tags`: `string`[]`keywords`: `string`[]`description`: `string` \| `JSX.Elementimage`: `stringauthor`: `stringorder`: `numbermenu`: `stringtemplate`: `Example`<`Props`>`stories`: `string`[]`source`: `stringfileName`: `stringpackage`: `stringtestFiles`: `string`[]`testCoverage`: `string`[]`testData`: `stringrenderFn`: FrameworkRenderFn`data`: DocumentData`componentsLookup`[`string`]: `stringMDXPage`: `anyisMDXComponent`: `booleanparameters`: `anycomponentat`: `subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`: ComponentControls`smartControls`: SmartControls`decorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `stringnavSidebar`: `booleancontextSidebar`: `booleanfullPage`: `booleanstories`[`string`]: `typename`: `stringstoryName`: `stringid`: `stringrawId`: `stringdoc`: `stringstoryFn`: StoryRenderFn`description`: `stringarguments`: StoryArguments`loc`: CodeLocation`source`: `stringsubtitle`: `stringdynamic`: `booleandynamicId`: `stringcomponentat`: `subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`: ComponentControls`smartControls`: SmartControls`decorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `stringcomponents`[`string`]: `interfacename`: `stringimportedName`: `"default"` \| `"namespace"` \| `stringfrom`: `stringrequest`: `stringfileName`: `stringpropsInfoFile`: `stringloc`: CodeLocation`package`: `stringsource`: `stringinfo`: ComponentInfo`externalDependencies`: Imports`localDependencies`: Imports`jsx`: JSXTree`fileInfo`: FileInfo`jest`: JestTests`packages`[`string`]: `interfacefileHash`: `stringname`: `stringversion`: `stringdependencies`: PackageDependencies`devDependencies`: PackageDependencies`peerDependencies`: PackageDependencies`privateNpm`: `booleanrepository``browse`: `docs`: `issues`: `addObserver`: function (`observer`: function* (`story`: Story) => `void`) => `voidremoveObserver`: function* (`observer`: function* (`story`: Story) => `void`) => `voidupdateStory`: function* (`story``name`: `stringstoryName`: `stringid`: `stringrawId`: `stringdoc`: `stringstoryFn`: StoryRenderFn`description`: `stringarguments`: StoryArguments`loc`: CodeLocation`source`: `stringsubtitle`: `stringdynamic`: `booleandynamicId`: `stringcomponent`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`: ComponentControls`smartControls`: SmartControls`decorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `string`) => `voidsearch`: function (`store``error`: `config`: `docs`: `stories`: `components`: `packages`: `addObserver`: `removeObserver`: `updateStory`: `search`: ) => `SearchResultitems`: `SearchItem`[]`searchFn`: function* (`search`: ) => `voidproviderlogo`: `url`: `name`:	Store of stories information in memory after the loader is applied
`returns`	`HomePageInfo`