# @component-controls/store

> Component controls shared store

Latest version **4.0.3** (published 2022-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @component-controls/store
pnpm add @component-controls/store
yarn add @component-controls/store
bun add @component-controls/store
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.3 |
| Published | 2022-01-14 |
| First published | 2020-04-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 10 |
| Unpacked size | 501.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 82 |
| Maintainers | atanasster |

## Links

- npm: https://www.npmjs.com/package/@component-controls/store
- Repository: https://github.com/ccontrols/component-controls
- Issues: https://github.com/ccontrols/component-controls/issues
- npm.io page: https://npm.io/package/@component-controls/store

## Dependencies (10)

- [path](https://npm.io/package/path.md) ^0.12.7
- [recoil](https://npm.io/package/recoil.md) ^0.3.0
- [analytics](https://npm.io/package/analytics.md) ^0.5.2
- [typescript](https://npm.io/package/typescript.md) ^4.2.4
- [broadcast-channel](https://npm.io/package/broadcast-channel.md) ^3.1.0
- [@component-controls/core](https://npm.io/package/@component-controls/core.md) ^4.0.3
- [@component-controls/loader](https://npm.io/package/@component-controls/loader.md) ^4.0.3
- [@component-controls/logger](https://npm.io/package/@component-controls/logger.md) ^4.0.3
- [@component-controls/render](https://npm.io/package/@component-controls/render.md) ^4.0.3
- [@analytics/google-analytics](https://npm.io/package/@analytics/google-analytics.md) ^0.5.2

## Recent versions

- 4.0.3 (latest) — 2022-01-14
- 3.15.0 — 2021-07-21
- 3.14.6 — 2021-05-20
- 3.14.5 — 2021-05-19
- 3.14.3 — 2021-05-18
- 3.14.2 — 2021-05-18
- 3.14.0 — 2021-05-17
- 3.13.0 — 2021-05-17
- 3.12.0 — 2021-05-13
- 3.11.4 — 2021-05-11
- 3.11.3 — 2021-05-10
- 3.11.1 — 2021-05-10
- 3.11.0 — 2021-05-10
- 3.10.4 — 2021-05-09
- 3.10.3 — 2021-05-09
- … 200 more at https://npm.io/package/@component-controls/store/versions

## README

# Table of contents

-   [Overview](#overview)
-   [Installation](#installation)
-   [API](#api)
    -   [ControlUpdateFn](#controlupdatefn)
    -   [StoreContext](#storecontext)
    -   [useDocPropCount](#usedocpropcount)
    -   [ComponentInputProps](#componentinputprops)
    -   [ControlsContextProps](#controlscontextprops)
    -   [StoreContextProvider](#storecontextprovider)
    -   [StateRootProps](#staterootprops)
    -   [DocumentContextProvider](#documentcontextprovider)
    -   [StoryContext](#storycontext)
    -   [LoadingStore](#loadingstore)
    -   [loadStore](#loadstore)
    -   [ControlsContextStoryProvider](#controlscontextstoryprovider)
    -   [StoryContextProvider](#storycontextprovider)
    -   [useStore](#usestore)
    -   [useDocument](#usedocument)
    -   [ConfigContext](#configcontext)
    -   [StateRoot](#stateroot)
    -   [useGetDocument](#usegetdocument)
    -   [ConfigContextProvider](#configcontextprovider)
    -   [useDocsByCategory](#usedocsbycategory)
    -   [useComponents](#usecomponents)
    -   [useCurrentDocument](#usecurrentdocument)
    -   [useStoryControls](#usestorycontrols)
    -   [useDocPackage](#usedocpackage)
    -   [ControlsStateProviderProps](#controlsstateproviderprops)
    -   [useConfigState](#useconfigstate)
    -   [ControlsStateProvider](#controlsstateprovider)
    -   [useDocs](#usedocs)
    -   [useConfig](#useconfig)
    -   [usePages](#usepages)
    -   [DocSortOrder](#docsortorder)
    -   [useThemeState](#usethemestate)
    -   [useControl](#usecontrol)
    -   [docSortFn](#docsortfn)
    -   [useCurrentStory](#usecurrentstory)
    -   [useTheme](#usetheme)
    -   [useStoryById](#usestorybyid)
    -   [ActiveTabContextProvider](#activetabcontextprovider)
    -   [useStoryIdFromName](#usestoryidfromname)
    -   [DocsSortContextProvider](#docssortcontextprovider)
    -   [useActiveTab](#useactivetab)
    -   [usePackage](#usepackage)
    -   [StoryInputProps](#storyinputprops)
    -   [useDocSort](#usedocsort)
    -   [useStoryId](#usestoryid)
    -   [OptionsContextProvider](#optionscontextprovider)
    -   [useUserData](#useuserdata)
    -   [useStory](#usestory)
    -   [useDocByType](#usedocbytype)
    -   [useGetDocByType](#usegetdocbytype)
    -   [useComponent](#usecomponent)
    -   [useSortedDocByType](#usesorteddocbytype)
    -   [useStoryComponent](#usestorycomponent)
    -   [DocCountType](#doccounttype)
    -   [useDocTypeCount](#usedoctypecount)
    -   [useCurrentPropsCount](#usecurrentpropscount)
    -   [useStoryPath](#usestorypath)
    -   [useGetStoryPath](#usegetstorypath)
    -   [useNavigationInfo](#usenavigationinfo)
    -   [useDocumentPath](#usedocumentpath)
    -   [useGetDocumentPath](#usegetdocumentpath)
    -   [useDocDescription](#usedocdescription)
    -   [useSearch](#usesearch)

# Overview

Utility functions and hooks to abstract loading and using the store. Can also share the store across bundles using localStorage and broadcasting messages.

[Store reference documentation](https://component-controls.com/tutorial/reference/store)

# Installation

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

```bash
$ npm install @component-controls/store --save-dev
```

# API

<api-readme maxDepth=5/>

<!-- START-API-README -->

## ControlUpdateFn

**`function`**

_defined in [@component-controls/store/core/store/src/state/context/controls.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/controls.tsx#L10)_

**parameters**

| Name        | Type                    |
| ----------- | ----------------------- |
| `name*`     | `string` \| `undefined` |
| `newValue*` | `any`                   |

## StoreContext

**`interface`**

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L19)_

**properties**

| Name          | Type                                                                                                                                          | Parent    |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `Provider*`   | <details><summary>`type`</summary><blockquote>`propTypes`: `WeakValidationMap`&lt;> \| `undefined`<br />`$$typeof`\*: </blockquote></details> | `Context` |
| `Consumer*`   | <details><summary>`type`</summary><blockquote>`$$typeof`\*: </blockquote></details>                                                           | `Context` |
| `displayName` | `string` \| `undefined`                                                                                                                       | `Context` |

## useDocPropCount

**`function`**

Returns the number of documents by unique values in their \`category\` field

_defined in [@component-controls/store/core/store/src/state/context/categories.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/categories.tsx#L8)_

**parameters**

| Name        | Type                            |
| ----------- | ------------------------------- |
| `category*` | `string`                        |
| `returns`   | [`DocCountType`](#doccounttype) |

## ComponentInputProps

**`interface`**

_defined in [@component-controls/store/core/store/src/state/context/components.ts](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/components.ts#L13)_

**properties**

| Name   | Type     | Description                                                                                                                                                                                                                                                                                        |
| ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `of`   | `any`    | Specify the component(s), for which to have information displayed. The default, a value of  `"."`  will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. |
| `name` | `string` | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls                                                                                                                                                    |

## ControlsContextProps

**`interface`**

_defined in [@component-controls/store/core/store/src/state/context/controls.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/controls.tsx#L12)_

**properties**

| Name           | Type                                                                                                                                                                                                                                                                                                                                                                                               | Description                                                                                                                |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `controls`     | <details><summary>`ComponentControls`&lt;></summary><blockquote>\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`&lt;> \| `ComponentControlButton`&lt;> \| `ComponentControlOptions`&lt;> \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`</blockquote></details> | ComponentControls are defined in key value pairs the name of the property is the key and the value is the ComponentControl |
| `updateValue*` | [`ControlUpdateFn`](#controlupdatefn)                                                                                                                                                                                                                                                                                                                                                              |                                                                                                                            |

## StoreContextProvider

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L23)_

**properties**

| Name     | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `store*` | <details><summary>`Store`</summary><blockquote>`error`: `string`<br /><details><summary>`config`\*</summary><blockquote>`author`: `string`<br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details>`description`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br /><details><summary>`footer`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`menu`: `StaticMenuItem`\[]<br />`title`: `string`<br />`image`: `string`<br />`logo`: `string` \| `ReactNode`<br /><details><summary>`app`</summary><blockquote>`propTypes`\*: <br />`contextTypes`\*: <br />`defaultProps`\*: <br />`displayName`\*: </blockquote></details>`copyright`: `string`<br />`language`: `string`<br />`links`: (`DetailedHTMLProps`&lt;>)\[]<br />`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined`<br /><details><summary>`pages`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`theme`</summary><blockquote>\[`string`]: `any`</blockquote></details>`storySort`: **function** (<br />`a`\*: `string`<br />`b`\*: `string`<br />) => `number`<br /><details><summary>`toolbar`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`sidebar`: `ActionItem`\[]<br />`components`: `Record`&lt;`string`, `unknown`><br />`analytics`: `any`<br />`renderFn`: **function** (<br /><details><summary>`props`\*</summary><blockquote>`story`\*: <br />`doc`\*: <br />`values`\*: <br />`options`\*: </blockquote></details>) => `any`<br />`webpack`: `Configuration` \| `WebpackConfigFn`<br />`finalWebpack`: `Configuration` \| `WebpackConfigFn`<br />`presets`: `RuleType`\[]<br />`configPath`: `string`<br />`distFolder`: `string`<br />`bundleName`: `string`<br />`staticFolder`: `string`<br />`cssFileName`: `string`<br />`logOptions`: `Partial`&lt;`LogOptions`><br />`mode`: `"none"` \| `"development"` \| `"production"`<br /><details><summary>`loaders`</summary><blockquote>`at`\*: <br />`module`\*: <br />`ident`\*: <br />`loader`\*: <br />`options`\*: </blockquote></details>`stories`: `string` \| `string`\[]<br />`files`: `string` \| `string`\[]<br />`siteRoot`: `string`<br />`ignore`: `string`\[]<br />`categories`: `DocType`\[]<br />`siteMap`: `type` \| `boolean`<br />`siteUrl`: `string`<br />`instrument`: `any`<br /><details><summary>`search`</summary><blockquote>`indexingModule`\*: <br />`searchingModule`\*: <br />`fields`\*: <br />`emptySearchDocuments`\*: <br />`hitsPerPage`\*: <br />`options`\*: </blockquote></details><details><summary>`tokens`</summary><blockquote>`figmaAccessToken`\*: <br />`githubAccessToken`\*: </blockquote></details></blockquote></details><details><summary>`docs`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>\[`string`]: `any`<br />`title`\*: `string`<br />`type`: DocType<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br />`template`: `Example`&lt;`Props`><br />`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: FrameworkRenderFn<br />`data`: DocumentData<br /><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details></blockquote></details><details><summary>`stories`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details></blockquote></details><details><summary>`components`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`name`\*: `string`<br />`importedName`: `"default"` \| `"namespace"` \| `string`<br />`from`: `string`<br />`request`: `string`<br />`fileName`: `string`<br />`propsInfoFile`: `string`<br />`loc`: CodeLocation<br />`package`: `string`<br />`source`: `string`<br />`info`: ComponentInfo<br />`externalDependencies`: Imports<br />`localDependencies`: Imports<br />`jsx`: JSXTree<br />`fileInfo`: FileInfo<br />`jest`: JestTests</blockquote></details></blockquote></details><details><summary>`packages`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`fileHash`\*: `string`<br />`name`: `string`<br />`version`: `string`<br />`dependencies`: PackageDependencies<br />`devDependencies`: PackageDependencies<br />`peerDependencies`: PackageDependencies<br />`privateNpm`: `boolean`<br /><details><summary>`repository`\*</summary><blockquote>`browse`\*: <br />`docs`\*: <br />`issues`\*: </blockquote></details></blockquote></details></blockquote></details>`addObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`removeObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`updateStory`\*: **function** (<br /><details><summary>`story`\*</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details>) => `void`<br />`search`: **function** (<br /><details><summary>`store`\*</summary><blockquote>`error`\*: <br />`config`\*: <br />`docs`\*: <br />`stories`\*: <br />`components`\*: <br />`packages`\*: <br />`addObserver`\*: <br />`removeObserver`\*: <br />`updateStory`\*: <br />`search`\*: </blockquote></details>) => <details><summary>`SearchResult`</summary><blockquote>`items`\*: `SearchItem`\[]<br />`searchFn`\*: **function** (<br />`search`\*: <br />) => `void`<br /><details><summary>`provider`</summary><blockquote>`logo`\*: <br />`url`\*: <br />`name`\*: </blockquote></details></blockquote></details></blockquote></details> |

## StateRootProps

**`interface`**

_defined in [@component-controls/store/core/store/src/state/context/StateRoot.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/StateRoot.tsx#L13)_

**properties**

| Name        | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Description                                                                             |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `storyId`   | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | current story id                                                                        |
| `docId`     | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | current documentation page, if no story is selected                                     |
| `store*`    | <details><summary>`Store`</summary><blockquote>`error`: `string`<br /><details><summary>`config`\*</summary><blockquote>`author`: `string`<br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details>`description`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br /><details><summary>`footer`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`menu`: `StaticMenuItem`\[]<br />`title`: `string`<br />`image`: `string`<br />`logo`: `string` \| `ReactNode`<br /><details><summary>`app`</summary><blockquote>`propTypes`\*: <br />`contextTypes`\*: <br />`defaultProps`\*: <br />`displayName`\*: </blockquote></details>`copyright`: `string`<br />`language`: `string`<br />`links`: (`DetailedHTMLProps`&lt;>)\[]<br />`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined`<br /><details><summary>`pages`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`theme`</summary><blockquote>\[`string`]: `any`</blockquote></details>`storySort`: **function** (<br />`a`\*: `string`<br />`b`\*: `string`<br />) => `number`<br /><details><summary>`toolbar`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`sidebar`: `ActionItem`\[]<br />`components`: `Record`&lt;`string`, `unknown`><br />`analytics`: `any`<br />`renderFn`: **function** (<br /><details><summary>`props`\*</summary><blockquote>`story`\*: <br />`doc`\*: <br />`values`\*: <br />`options`\*: </blockquote></details>) => `any`<br />`webpack`: `Configuration` \| `WebpackConfigFn`<br />`finalWebpack`: `Configuration` \| `WebpackConfigFn`<br />`presets`: `RuleType`\[]<br />`configPath`: `string`<br />`distFolder`: `string`<br />`bundleName`: `string`<br />`staticFolder`: `string`<br />`cssFileName`: `string`<br />`logOptions`: `Partial`&lt;`LogOptions`><br />`mode`: `"none"` \| `"development"` \| `"production"`<br /><details><summary>`loaders`</summary><blockquote>`at`\*: <br />`module`\*: </blockquote></details>`stories`: `string` \| `string`\[]<br />`files`: `string` \| `string`\[]<br />`siteRoot`: `string`<br />`ignore`: `string`\[]<br />`categories`: `DocType`\[]<br />`siteMap`: `type` \| `boolean`<br />`siteUrl`: `string`<br />`instrument`: `any`<br /><details><summary>`search`</summary><blockquote>`indexingModule`\*: <br />`searchingModule`\*: <br />`fields`\*: <br />`emptySearchDocuments`\*: <br />`hitsPerPage`\*: <br />`options`\*: </blockquote></details><details><summary>`tokens`</summary><blockquote>`figmaAccessToken`\*: <br />`githubAccessToken`\*: </blockquote></details></blockquote></details><details><summary>`docs`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>\[`string`]: `any`<br />`title`\*: `string`<br />`type`: DocType<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br />`template`: `Example`&lt;`Props`><br />`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: FrameworkRenderFn<br />`data`: DocumentData<br /><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details></blockquote></details><details><summary>`stories`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details></blockquote></details><details><summary>`components`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`name`\*: `string`<br />`importedName`: `"default"` \| `"namespace"` \| `string`<br />`from`: `string`<br />`request`: `string`<br />`fileName`: `string`<br />`propsInfoFile`: `string`<br />`loc`: CodeLocation<br />`package`: `string`<br />`source`: `string`<br />`info`: ComponentInfo<br />`externalDependencies`: Imports<br />`localDependencies`: Imports<br />`jsx`: JSXTree<br />`fileInfo`: FileInfo<br />`jest`: JestTests</blockquote></details></blockquote></details><details><summary>`packages`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`fileHash`\*: `string`<br />`name`: `string`<br />`version`: `string`<br />`dependencies`: PackageDependencies<br />`devDependencies`: PackageDependencies<br />`peerDependencies`: PackageDependencies<br />`privateNpm`: `boolean`<br /><details><summary>`repository`\*</summary><blockquote>`browse`\*: <br />`docs`\*: <br />`issues`\*: </blockquote></details></blockquote></details></blockquote></details>`addObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`removeObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`updateStory`\*: **function** (<br /><details><summary>`story`\*</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details>) => `void`<br />`search`: **function** (<br /><details><summary>`store`\*</summary><blockquote>`error`\*: <br />`config`\*: <br />`docs`\*: <br />`stories`\*: <br />`components`\*: <br />`packages`\*: <br />`addObserver`\*: <br />`removeObserver`\*: <br />`updateStory`\*: <br />`search`\*: </blockquote></details>) => <details><summary>`SearchResult`</summary><blockquote>`items`\*: `SearchItem`\[]<br />`searchFn`\*: **function** (<br />`search`\*: <br />) => `void`<br /><details><summary>`provider`</summary><blockquote>`logo`\*: <br />`url`\*: <br />`name`\*: </blockquote></details></blockquote></details></blockquote></details> | store object                                                                            |
| `activeTab` | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | active page tab                                                                         |
| `values`    | `any`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | initial control values. usually passed from the url                                     |
| `userData`  | `Record`&lt;`string`, `any`>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | user options passed from container those can be global parameters as well as decorators |

## DocumentContextProvider

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L19)_

**properties**

| Name     | Type                    |
| -------- | ----------------------- |
| `docId*` | `string` \| `undefined` |

## StoryContext

**`interface`**

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L26)_

**properties**

| Name          | Type                                                                                                                                          | Parent    |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `Provider*`   | <details><summary>`type`</summary><blockquote>`propTypes`: `WeakValidationMap`&lt;> \| `undefined`<br />`$$typeof`\*: </blockquote></details> | `Context` |
| `Consumer*`   | <details><summary>`type`</summary><blockquote>`$$typeof`\*: </blockquote></details>                                                           | `Context` |
| `displayName` | `string` \| `undefined`                                                                                                                       | `Context` |

## LoadingStore

**`interface`**

_defined in [@component-controls/loader/core/loader/dist/store.d.ts](https://github.com/ccontrols/component-controls/tree/master/core/loader/dist/store.d.ts#L4)_

**properties**

| Name          | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Description                                                                    |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| `error`       | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | build-time error                                                               |
| `config`      | <details><summary>`RunConfiguration`</summary><blockquote>`author`: `string`<br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details>`description`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br /><details><summary>`footer`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`menu`: `StaticMenuItem`\[]<br />`title`: `string`<br />`image`: `string`<br />`logo`: `string` \| `ReactNode`<br /><details><summary>`app`</summary><blockquote>`propTypes`\*: <br />`contextTypes`\*: <br />`defaultProps`\*: <br />`displayName`\*: </blockquote></details>`copyright`: `string`<br />`language`: `string`<br />`links`: (`DetailedHTMLProps`&lt;>)\[]<br />`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined`<br /><details><summary>`pages`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`theme`</summary><blockquote>\[`string`]: `any`</blockquote></details>`storySort`: **function** (<br />`a`\*: `string`<br />`b`\*: `string`<br />) => `number`<br /><details><summary>`toolbar`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`sidebar`: `ActionItem`\[]<br />`components`: `Record`&lt;`string`, `unknown`><br />`analytics`: `any`<br />`renderFn`: **function** (<br /><details><summary>`props`\*</summary><blockquote>`story`\*: <br />`doc`\*: <br />`values`\*: <br />`options`\*: </blockquote></details>) => `any`<br />`webpack`: `Configuration` \| `WebpackConfigFn`<br />`finalWebpack`: `Configuration` \| `WebpackConfigFn`<br />`presets`: `RuleType`\[]<br />`configPath`: `string`<br />`distFolder`: `string`<br />`bundleName`: `string`<br />`staticFolder`: `string`<br />`cssFileName`: `string`<br />`logOptions`: `Partial`&lt;`LogOptions`><br />`mode`: `"none"` \| `"development"` \| `"production"`<br /><details><summary>`loaders`</summary><blockquote>`at`\*: <br />`module`\*: </blockquote></details>`stories`: `string` \| `string`\[]<br />`files`: `string` \| `string`\[]<br />`siteRoot`: `string`<br />`ignore`: `string`\[]<br />`categories`: `DocType`\[]<br />`siteMap`: `type` \| `boolean`<br />`siteUrl`: `string`<br />`instrument`: `any`<br /><details><summary>`search`</summary><blockquote>`indexingModule`\*: <br />`searchingModule`\*: <br />`fields`\*: <br />`emptySearchDocuments`\*: <br />`hitsPerPage`\*: <br />`options`\*: </blockquote></details><details><summary>`tokens`</summary><blockquote>`figmaAccessToken`\*: <br />`githubAccessToken`\*: </blockquote></details></blockquote></details> | global configuration from project config file                                  |
| `buildConfig` | <details><summary>`BuildConfiguration`</summary><blockquote>`webpack`: `Configuration` \| `WebpackConfigFn`<br />`finalWebpack`: `Configuration` \| `WebpackConfigFn`<br />`presets`: `RuleType`\[]<br />`configPath`: `string`<br />`distFolder`: `string`<br />`bundleName`: `string`<br />`staticFolder`: `string`<br />`cssFileName`: `string`<br />`logOptions`: `Partial`&lt;`LogOptions`><br />`mode`: `"none"` \| `"development"` \| `"production"`<br /><details><summary>`loaders`</summary><blockquote>`at`\*: <br />`module`\*: </blockquote></details>`stories`: `string` \| `string`\[]<br />`files`: `string` \| `string`\[]<br />`siteRoot`: `string`<br />`ignore`: `string`\[]<br /><details><summary>`pages`</summary><blockquote>\[`string`]: </blockquote></details>`categories`: `DocType`\[]<br />`siteMap`: `type` \| `boolean`<br />`siteUrl`: `string`<br />`instrument`: `any`<br /><details><summary>`search`</summary><blockquote>`indexingModule`\*: <br />`searchingModule`\*: <br />`fields`\*: <br />`emptySearchDocuments`\*: <br />`hitsPerPage`\*: <br />`options`\*: </blockquote></details><details><summary>`tokens`</summary><blockquote>`figmaAccessToken`\*: <br />`githubAccessToken`\*: </blockquote></details>`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | global configuration used at build time stored in a file named main.js/main.ts |
| `packages*`   | <details><summary>`Packages`</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`fileHash`\*: `string`<br />`name`: `string`<br />`version`: `string`<br /><details><summary>`dependencies`</summary><blockquote>\[`string`]: PackageDependency</blockquote></details><details><summary>`devDependencies`</summary><blockquote>\[`string`]: PackageDependency</blockquote></details><details><summary>`peerDependencies`</summary><blockquote>\[`string`]: PackageDependency</blockquote></details>`privateNpm`: `boolean`<br /><details><summary>`repository`\*</summary><blockquote>`browse`: `string`<br />`docs`: `string`<br />`issues`: `string`</blockquote></details></blockquote></details></blockquote></details>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | global store of packages                                                       |
| `components*` | <details><summary>`Components`</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`name`\*: `string`<br />`importedName`: `"default"` \| `"namespace"` \| `string`<br />`from`: `string`<br />`request`: `string`<br />`fileName`: `string`<br />`propsInfoFile`: `string`<br /><details><summary>`loc`</summary><blockquote>`start`\*: <br />`end`\*: </blockquote></details>`package`: `string`<br />`source`: `string`<br /><details><summary>`info`</summary><blockquote>`displayName`\*: <br />`description`\*: <br />`props`\*: </blockquote></details><details><summary>`externalDependencies`</summary><blockquote>\[`string`]: (`Omit`&lt;`ImportType`, `"from"`>)\[]</blockquote></details><details><summary>`localDependencies`</summary><blockquote>\[`string`]: (`Omit`&lt;`ImportType`, `"from"`>)\[]</blockquote></details>`jsx`: `JSXNode`\[]<br /><details><summary>`fileInfo`</summary><blockquote>`dateCreated`\*: <br />`dateModified`\*: <br />`commits`\*: <br />`sloc`\*: </blockquote></details><details><summary>`jest`</summary><blockquote>`results`\*: <br />`coverage`\*: </blockquote></details></blockquote></details></blockquote></details>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | global store of components                                                     |
| `stores*`     | `type`\[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | stores, loaded from each .stories.\* file                                      |
| `search`      | **function** (<br /><details><summary>`store`\*</summary><blockquote>`error`: `string`<br /><details><summary>`config`\*</summary><blockquote>`author`\*: <br />`controls`\*: <br />`description`\*: <br />`component`\*: <br />`subcomponents`\*: <br />`smartControls`\*: <br />`decorators`\*: <br />`plugins`\*: <br />`category`\*: <br />`footer`\*: <br />`menu`\*: <br />`title`\*: <br />`image`\*: <br />`logo`\*: <br />`app`\*: <br />`copyright`\*: <br />`language`\*: <br />`links`\*: <br />`seo`\*: <br />`pages`\*: <br />`theme`\*: <br />`storySort`\*: <br />`toolbar`\*: <br />`sidebar`\*: <br />`components`\*: <br />`analytics`\*: <br />`renderFn`\*: <br />`webpack`\*: <br />`finalWebpack`\*: <br />`presets`\*: <br />`configPath`\*: <br />`distFolder`\*: <br />`bundleName`\*: <br />`staticFolder`\*: <br />`cssFileName`\*: <br />`logOptions`\*: <br />`mode`\*: <br />`loaders`\*: <br />`stories`\*: <br />`files`\*: <br />`siteRoot`\*: <br />`ignore`\*: <br />`categories`\*: <br />`siteMap`\*: <br />`siteUrl`\*: <br />`instrument`\*: <br />`search`\*: <br />`tokens`\*: </blockquote></details><details><summary>`docs`\*</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`stories`\*</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`components`\*</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`packages`\*</summary><blockquote>\[`string`]: </blockquote></details>`addObserver`\*: **function** (<br />`observer`\*: <br />) => `void`<br />`removeObserver`\*: **function** (<br />`observer`\*: <br />) => `void`<br />`updateStory`\*: **function** (<br />`story`\*: <br />) => `void`<br />`search`\*: </blockquote></details>) => <details><summary>`SearchResult`</summary><blockquote>`items`\*: `SearchItem`\[]<br />`searchFn`\*: **function** (<br />`search`\*: <br />) => `void`<br /><details><summary>`provider`</summary><blockquote>`logo`\*: <br />`url`\*: <br />`name`\*: </blockquote></details></blockquote></details>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                                                |

## loadStore

**`function`**

_defined in [@component-controls/store/core/store/src/serialization/load-store.ts](https://github.com/ccontrols/component-controls/tree/master/core/store/src/serialization/load-store.ts#L25)_

**parameters**

| Name       | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Description                                                        |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `store*`   | [`LoadingStore`](#loadingstore)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                                    |
| `building` | `boolean`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                                    |
| `returns`  | <details><summary>`Store`</summary><blockquote>`error`: `string`<br /><details><summary>`config`\*</summary><blockquote>`author`: `string`<br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details>`description`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br /><details><summary>`footer`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`menu`: `StaticMenuItem`\[]<br />`title`: `string`<br />`image`: `string`<br />`logo`: `string` \| `ReactNode`<br /><details><summary>`app`</summary><blockquote>`propTypes`\*: <br />`contextTypes`\*: <br />`defaultProps`\*: <br />`displayName`\*: </blockquote></details>`copyright`: `string`<br />`language`: `string`<br />`links`: (`DetailedHTMLProps`&lt;>)\[]<br />`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined`<br /><details><summary>`pages`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`theme`</summary><blockquote>\[`string`]: `any`</blockquote></details>`storySort`: **function** (<br />`a`\*: `string`<br />`b`\*: `string`<br />) => `number`<br /><details><summary>`toolbar`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`sidebar`: `ActionItem`\[]<br />`components`: `Record`&lt;`string`, `unknown`><br />`analytics`: `any`<br />`renderFn`: **function** (<br /><details><summary>`props`\*</summary><blockquote>`story`\*: <br />`doc`\*: <br />`values`\*: <br />`options`\*: </blockquote></details>) => `any`<br />`webpack`: `Configuration` \| `WebpackConfigFn`<br />`finalWebpack`: `Configuration` \| `WebpackConfigFn`<br />`presets`: `RuleType`\[]<br />`configPath`: `string`<br />`distFolder`: `string`<br />`bundleName`: `string`<br />`staticFolder`: `string`<br />`cssFileName`: `string`<br />`logOptions`: `Partial`&lt;`LogOptions`><br />`mode`: `"none"` \| `"development"` \| `"production"`<br /><details><summary>`loaders`</summary><blockquote>`at`\*: <br />`module`\*: </blockquote></details>`stories`: `string` \| `string`\[]<br />`files`: `string` \| `string`\[]<br />`siteRoot`: `string`<br />`ignore`: `string`\[]<br />`categories`: `DocType`\[]<br />`siteMap`: `type` \| `boolean`<br />`siteUrl`: `string`<br />`instrument`: `any`<br /><details><summary>`search`</summary><blockquote>`indexingModule`\*: <br />`searchingModule`\*: <br />`fields`\*: <br />`emptySearchDocuments`\*: <br />`hitsPerPage`\*: <br />`options`\*: </blockquote></details><details><summary>`tokens`</summary><blockquote>`figmaAccessToken`\*: <br />`githubAccessToken`\*: </blockquote></details></blockquote></details><details><summary>`docs`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>\[`string`]: `any`<br />`title`\*: `string`<br />`type`: DocType<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br />`template`: `Example`&lt;`Props`><br />`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: FrameworkRenderFn<br />`data`: DocumentData<br /><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br /><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details></blockquote></details><details><summary>`stories`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br /><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details></blockquote></details><details><summary>`components`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`name`\*: `string`<br />`importedName`: `"default"` \| `"namespace"` \| `string`<br />`from`: `string`<br />`request`: `string`<br />`fileName`: `string`<br />`propsInfoFile`: `string`<br />`loc`: CodeLocation<br />`package`: `string`<br />`source`: `string`<br />`info`: ComponentInfo<br />`externalDependencies`: Imports<br />`localDependencies`: Imports<br />`jsx`: JSXTree<br />`fileInfo`: FileInfo<br />`jest`: JestTests</blockquote></details></blockquote></details><details><summary>`packages`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`fileHash`\*: `string`<br />`name`: `string`<br />`version`: `string`<br />`dependencies`: PackageDependencies<br />`devDependencies`: PackageDependencies<br />`peerDependencies`: PackageDependencies<br />`privateNpm`: `boolean`<br /><details><summary>`repository`\*</summary><blockquote>`browse`\*: <br />`docs`\*: <br />`issues`\*: </blockquote></details></blockquote></details></blockquote></details>`addObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`removeObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`updateStory`\*: **function** (<br /><details><summary>`story`\*</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br /><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details>) => `void`<br />`search`: **function** (<br /><details><summary>`store`\*</summary><blockquote>`error`\*: <br />`config`\*: <br />`docs`\*: <br />`stories`\*: <br />`components`\*: <br />`packages`\*: <br />`addObserver`\*: <br />`removeObserver`\*: <br />`updateStory`\*: <br />`search`\*: </blockquote></details>) => <details><summary>`SearchResult`</summary><blockquote>`items`\*: `SearchItem`\[]<br />`searchFn`\*: **function** (<br />`search`\*: <br />) => `void`<br /><details><summary>`provider`</summary><blockquote>`logo`\*: <br />`url`\*: <br />`name`\*: </blockquote></details></blockquote></details></blockquote></details> | Store of stories information in memory after the loader is applied |

## ControlsContextStoryProvider

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/controls.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/controls.tsx#L21)_

## StoryContextProvider

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L31)_

**properties**

| Name      | Type     |
| --------- | -------- |
| `storyId` | `string` |
| `values`  | `any`    |

## useStore

**`function`**

Returns the global store object

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L41)_

**parameters**

| Name      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Description                                                        |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| `returns` | <details><summary>`Store`</summary><blockquote>`error`: `string`<br /><details><summary>`config`\*</summary><blockquote>`author`: `string`<br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details>`description`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br /><details><summary>`footer`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`menu`: `StaticMenuItem`\[]<br />`title`: `string`<br />`image`: `string`<br />`logo`: `string` \| `ReactNode`<br /><details><summary>`app`</summary><blockquote>`propTypes`\*: <br />`contextTypes`\*: <br />`defaultProps`\*: <br />`displayName`\*: </blockquote></details>`copyright`: `string`<br />`language`: `string`<br />`links`: (`DetailedHTMLProps`&lt;>)\[]<br />`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined`<br /><details><summary>`pages`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`theme`</summary><blockquote>\[`string`]: `any`</blockquote></details>`storySort`: **function** (<br />`a`\*: `string`<br />`b`\*: `string`<br />) => `number`<br /><details><summary>`toolbar`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`sidebar`: `ActionItem`\[]<br />`components`: `Record`&lt;`string`, `unknown`><br />`analytics`: `any`<br />`renderFn`: **function** (<br /><details><summary>`props`\*</summary><blockquote>`story`\*: <br />`doc`\*: <br />`values`\*: <br />`options`\*: </blockquote></details>) => `any`<br />`webpack`: `Configuration` \| `WebpackConfigFn`<br />`finalWebpack`: `Configuration` \| `WebpackConfigFn`<br />`presets`: `RuleType`\[]<br />`configPath`: `string`<br />`distFolder`: `string`<br />`bundleName`: `string`<br />`staticFolder`: `string`<br />`cssFileName`: `string`<br />`logOptions`: `Partial`&lt;`LogOptions`><br />`mode`: `"none"` \| `"development"` \| `"production"`<br /><details><summary>`loaders`</summary><blockquote>`at`\*: <br />`module`\*: </blockquote></details>`stories`: `string` \| `string`\[]<br />`files`: `string` \| `string`\[]<br />`siteRoot`: `string`<br />`ignore`: `string`\[]<br />`categories`: `DocType`\[]<br />`siteMap`: `type` \| `boolean`<br />`siteUrl`: `string`<br />`instrument`: `any`<br /><details><summary>`search`</summary><blockquote>`indexingModule`\*: <br />`searchingModule`\*: <br />`fields`\*: <br />`emptySearchDocuments`\*: <br />`hitsPerPage`\*: <br />`options`\*: </blockquote></details><details><summary>`tokens`</summary><blockquote>`figmaAccessToken`\*: <br />`githubAccessToken`\*: </blockquote></details></blockquote></details><details><summary>`docs`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>\[`string`]: `any`<br />`title`\*: `string`<br />`type`: DocType<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br />`template`: `Example`&lt;`Props`><br />`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: FrameworkRenderFn<br />`data`: DocumentData<br /><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details></blockquote></details><details><summary>`stories`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details></blockquote></details><details><summary>`components`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`name`\*: `string`<br />`importedName`: `"default"` \| `"namespace"` \| `string`<br />`from`: `string`<br />`request`: `string`<br />`fileName`: `string`<br />`propsInfoFile`: `string`<br />`loc`: CodeLocation<br />`package`: `string`<br />`source`: `string`<br />`info`: ComponentInfo<br />`externalDependencies`: Imports<br />`localDependencies`: Imports<br />`jsx`: JSXTree<br />`fileInfo`: FileInfo<br />`jest`: JestTests</blockquote></details></blockquote></details><details><summary>`packages`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`fileHash`\*: `string`<br />`name`: `string`<br />`version`: `string`<br />`dependencies`: PackageDependencies<br />`devDependencies`: PackageDependencies<br />`peerDependencies`: PackageDependencies<br />`privateNpm`: `boolean`<br /><details><summary>`repository`\*</summary><blockquote>`browse`\*: <br />`docs`\*: <br />`issues`\*: </blockquote></details></blockquote></details></blockquote></details>`addObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`removeObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`updateStory`\*: **function** (<br /><details><summary>`story`\*</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details>) => `void`<br />`search`: **function** (<br /><details><summary>`store`\*</summary><blockquote>`error`\*: <br />`config`\*: <br />`docs`\*: <br />`stories`\*: <br />`components`\*: <br />`packages`\*: <br />`addObserver`\*: <br />`removeObserver`\*: <br />`updateStory`\*: <br />`search`\*: </blockquote></details>) => <details><summary>`SearchResult`</summary><blockquote>`items`\*: `SearchItem`\[]<br />`searchFn`\*: **function** (<br />`search`\*: <br />) => `void`<br /><details><summary>`provider`</summary><blockquote>`logo`\*: <br />`url`\*: <br />`name`\*: </blockquote></details></blockquote></details></blockquote></details> | Store of stories information in memory after the loader is applied |

## useDocument

**`react function`**

Retrieves a Document object from a document id

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L34)_

**parameters**

| Name      | Type                           |
| --------- | ------------------------------ |
| `docId*`  | `string`                       |
| `returns` | `Document`&lt;> \| `undefined` |

## ConfigContext

**`interface`**

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L51)_

**properties**

| Name          | Type                                                                                                                                          | Parent    |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `Provider*`   | <details><summary>`type`</summary><blockquote>`propTypes`: `WeakValidationMap`&lt;> \| `undefined`<br />`$$typeof`\*: </blockquote></details> | `Context` |
| `Consumer*`   | <details><summary>`type`</summary><blockquote>`$$typeof`\*: </blockquote></details>                                                           | `Context` |
| `displayName` | `string` \| `undefined`                                                                                                                       | `Context` |

## StateRoot

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/StateRoot.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/StateRoot.tsx#L43)_

**properties**

| Name        | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Parent                              | Description                                                                             |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------- |
| `storyId`   | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | [`StateRootProps`](#staterootprops) | current story id                                                                        |
| `docId`     | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | [`StateRootProps`](#staterootprops) | current documentation page, if no story is selected                                     |
| `store*`    | <details><summary>`Store`</summary><blockquote>`error`: `string`<br /><details><summary>`config`\*</summary><blockquote>`author`: `string`<br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details>`description`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br /><details><summary>`footer`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`menu`: `StaticMenuItem`\[]<br />`title`: `string`<br />`image`: `string`<br />`logo`: `string` \| `ReactNode`<br /><details><summary>`app`</summary><blockquote>`propTypes`\*: <br />`contextTypes`\*: <br />`defaultProps`\*: <br />`displayName`\*: </blockquote></details>`copyright`: `string`<br />`language`: `string`<br />`links`: (`DetailedHTMLProps`&lt;>)\[]<br />`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined`<br /><details><summary>`pages`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`theme`</summary><blockquote>\[`string`]: `any`</blockquote></details>`storySort`: **function** (<br />`a`\*: `string`<br />`b`\*: `string`<br />) => `number`<br /><details><summary>`toolbar`</summary><blockquote>`left`\*: <br />`right`\*: </blockquote></details>`sidebar`: `ActionItem`\[]<br />`components`: `Record`&lt;`string`, `unknown`><br />`analytics`: `any`<br />`renderFn`: **function** (<br /><details><summary>`props`\*</summary><blockquote>`story`\*: <br />`doc`\*: <br />`values`\*: <br />`options`\*: </blockquote></details>) => `any`<br />`webpack`: `Configuration` \| `WebpackConfigFn`<br />`finalWebpack`: `Configuration` \| `WebpackConfigFn`<br />`presets`: `RuleType`\[]<br />`configPath`: `string`<br />`distFolder`: `string`<br />`bundleName`: `string`<br />`staticFolder`: `string`<br />`cssFileName`: `string`<br />`logOptions`: `Partial`&lt;`LogOptions`><br />`mode`: `"none"` \| `"development"` \| `"production"`<br /><details><summary>`loaders`</summary><blockquote>`at`\*: <br />`module`\*: </blockquote></details>`stories`: `string` \| `string`\[]<br />`files`: `string` \| `string`\[]<br />`siteRoot`: `string`<br />`ignore`: `string`\[]<br />`categories`: `DocType`\[]<br />`siteMap`: `type` \| `boolean`<br />`siteUrl`: `string`<br />`instrument`: `any`<br /><details><summary>`search`</summary><blockquote>`indexingModule`\*: <br />`searchingModule`\*: <br />`fields`\*: <br />`emptySearchDocuments`\*: <br />`hitsPerPage`\*: <br />`options`\*: </blockquote></details><details><summary>`tokens`</summary><blockquote>`figmaAccessToken`\*: <br />`githubAccessToken`\*: </blockquote></details></blockquote></details><details><summary>`docs`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>\[`string`]: `any`<br />`title`\*: `string`<br />`type`: DocType<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br />`template`: `Example`&lt;`Props`><br />`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: FrameworkRenderFn<br />`data`: DocumentData<br /><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details></blockquote></details><details><summary>`stories`\*</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details></blockquote></details><details><summary>`components`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`name`\*: `string`<br />`importedName`: `"default"` \| `"namespace"` \| `string`<br />`from`: `string`<br />`request`: `string`<br />`fileName`: `string`<br />`propsInfoFile`: `string`<br />`loc`: CodeLocation<br />`package`: `string`<br />`source`: `string`<br />`info`: ComponentInfo<br />`externalDependencies`: Imports<br />`localDependencies`: Imports<br />`jsx`: JSXTree<br />`fileInfo`: FileInfo<br />`jest`: JestTests</blockquote></details></blockquote></details><details><summary>`packages`\*</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`fileHash`\*: `string`<br />`name`: `string`<br />`version`: `string`<br />`dependencies`: PackageDependencies<br />`devDependencies`: PackageDependencies<br />`peerDependencies`: PackageDependencies<br />`privateNpm`: `boolean`<br /><details><summary>`repository`\*</summary><blockquote>`browse`\*: <br />`docs`\*: <br />`issues`\*: </blockquote></details></blockquote></details></blockquote></details>`addObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`removeObserver`\*: **function** (<br />`observer`\*: **function** (<br />`story`: Story<br />) => `void`<br />) => `void`<br />`updateStory`\*: **function** (<br /><details><summary>`story`\*</summary><blockquote>`name`\*: `string`<br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br />`arguments`: StoryArguments<br />`loc`: CodeLocation<br />`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`</blockquote></details>) => `void`<br />`search`: **function** (<br /><details><summary>`store`\*</summary><blockquote>`error`\*: <br />`config`\*: <br />`docs`\*: <br />`stories`\*: <br />`components`\*: <br />`packages`\*: <br />`addObserver`\*: <br />`removeObserver`\*: <br />`updateStory`\*: <br />`search`\*: </blockquote></details>) => <details><summary>`SearchResult`</summary><blockquote>`items`\*: `SearchItem`\[]<br />`searchFn`\*: **function** (<br />`search`\*: <br />) => `void`<br /><details><summary>`provider`</summary><blockquote>`logo`\*: <br />`url`\*: <br />`name`\*: </blockquote></details></blockquote></details></blockquote></details> |                                     | store object                                                                            |
| `activeTab` | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | [`StateRootProps`](#staterootprops) | active page tab                                                                         |
| `values`    | `any`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | [`StateRootProps`](#staterootprops) | initial control values. usually passed from the url                                     |
| `userData`  | `Record`&lt;`string`, `any`>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | [`StateRootProps`](#staterootprops) | user options passed from container those can be global parameters as well as decorators |

## useGetDocument

**`function`**

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L42)_

**parameters**

| Name      | Type                                                                             |
| --------- | -------------------------------------------------------------------------------- |
| `returns` | **function** (<br />`docId`\*: `string`<br />) => `Document`&lt;> \| `undefined` |

## ConfigContextProvider

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L57)_

## useDocsByCategory

**`function`**

Returns an array of documents that have a specific value in their \`category\` field

_defined in [@component-controls/store/core/store/src/state/context/categories.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/categories.tsx#L35)_

**parameters**

| Name        | Type                 |
| ----------- | -------------------- |
| `category*` | `string`             |
| `value`     | `string` \| `number` |
| `returns`   | (`Document`&lt;>)\[] |

## useComponents

**`function`**

If the \`of\` property is specified, will return the listed components, if \`of\` is not specified, will return the components specified in the component and subcomponent properties of the document or the story.

_defined in [@component-controls/store/core/store/src/state/context/components.ts](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/components.ts#L30)_

**parameters**

| Name          | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Description                      |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| _anonymous\*_ | [`ComponentInputProps`](#componentinputprops)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                  |
| `returns`     | <details><summary>`Components`</summary><blockquote>\[`string`]: <details><summary>`interface`</summary><blockquote>`name`\*: `string`<br />`importedName`: `"default"` \| `"namespace"` \| `string`<br />`from`: `string`<br />`request`: `string`<br />`fileName`: `string`<br />`propsInfoFile`: `string`<br /><details><summary>`loc`</summary><blockquote>`start`\*: <br />`end`\*: </blockquote></details>`package`: `string`<br />`source`: `string`<br /><details><summary>`info`</summary><blockquote>`displayName`\*: <br />`description`\*: <br />`props`\*: </blockquote></details><details><summary>`externalDependencies`</summary><blockquote>\[`string`]: (`Omit`&lt;`ImportType`, `"from"`>)\[]</blockquote></details><details><summary>`localDependencies`</summary><blockquote>\[`string`]: (`Omit`&lt;`ImportType`, `"from"`>)\[]</blockquote></details>`jsx`: `JSXNode`\[]<br /><details><summary>`fileInfo`</summary><blockquote>`dateCreated`\*: <br />`dateModified`\*: <br />`commits`\*: <br />`sloc`\*: </blockquote></details><details><summary>`jest`</summary><blockquote>`results`\*: <br />`coverage`\*: </blockquote></details></blockquote></details></blockquote></details> | list of components used in store |

## useCurrentDocument

**`react component`**

Returns the currently selected document

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L50)_

## useStoryControls

**`react function`**

Returns the controls associated with a story

_defined in [@component-controls/store/core/store/src/state/context/controls.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/controls.tsx#L46)_

**parameters**

| Name       | Type                                    |
| ---------- | --------------------------------------- |
| `storyId*` | `string`                                |
| `returns`  | `ComponentControls`&lt;> \| `undefined` |

## useDocPackage

**`react component`**

Returns the package information for the currently selected document

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L57)_

## ControlsStateProviderProps

**`interface`**

_defined in [@component-controls/store/core/store/src/state/context/controls.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/controls.tsx#L53)_

**properties**

| Name        | Type                                                                                                                                                                                                                                                                                                                                                                                               | Description                                                                                                                |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `onChange*` | [`ControlUpdateFn`](#controlupdatefn)                                                                                                                                                                                                                                                                                                                                                              |                                                                                                                            |
| `controls`  | <details><summary>`ComponentControls`&lt;></summary><blockquote>\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`&lt;> \| `ComponentControlButton`&lt;> \| `ComponentControlOptions`&lt;> \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`</blockquote></details> | ComponentControls are defined in key value pairs the name of the property is the key and the value is the ComponentControl |

## useConfigState

**`react component`**

Returns a configuration object and the setter method

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L79)_

## ControlsStateProvider

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/controls.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/controls.tsx#L57)_

**properties**

| Name        | Type                                                                                                                                                                                                                                                                                                                                                                                               | Parent                                                      | Description                                                                                                                |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `onChange*` | [`ControlUpdateFn`](#controlupdatefn)                                                                                                                                                                                                                                                                                                                                                              | [`ControlsStateProviderProps`](#controlsstateproviderprops) |                                                                                                                            |
| `controls`  | <details><summary>`ComponentControls`&lt;></summary><blockquote>\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`&lt;> \| `ComponentControlButton`&lt;> \| `ComponentControlOptions`&lt;> \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`</blockquote></details> | [`ControlsStateProviderProps`](#controlsstateproviderprops) | ComponentControls are defined in key value pairs the name of the property is the key and the value is the ComponentControl |

## useDocs

**`function`**

Returns a key-value object of all documents in the store

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L66)_

**parameters**

| Name      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Description                    |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| `returns` | <details><summary>`Documents`</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>\[`string`]: `any`<br />`title`\*: `string`<br />`type`: `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string`<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br /><details><summary>`template`</summary><blockquote>`bind`\*: <br />`storyName`\*: <br />`id`\*: <br />`rawId`\*: <br />`doc`\*: <br />`storyFn`\*: <br />`description`\*: <br />`loc`\*: <br />`source`\*: <br />`subtitle`\*: <br />`dynamic`\*: <br />`dynamicId`\*: <br />`component`\*: <br />`subcomponents`\*: <br />`smartControls`\*: <br />`decorators`\*: <br />`plugins`\*: <br />`category`\*: <br />`controls`\*: </blockquote></details>`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: **function** (<br />`props`\*: <br />) => `any`<br /><details><summary>`data`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br /><details><summary>`component`</summary><blockquote>`at`\*: **function** (<br />`index`\*: <br />) => `T` \| `undefined`</blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details></blockquote></details> | list of story files, or groups |

## useConfig

**`function`**

Returns the configuration object part of the store

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L91)_

**parameters**

| Name      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Description                          |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `returns` | <details><summary>`RunConfiguration`</summary><blockquote>`author`: `string`<br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`&lt;`P`> \| `ComponentControlButton` \| `ComponentControlOptions` \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`</blockquote></details>`description`: `string`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`smartControls`</summary><blockquote>`smart`: `boolean`<br />`include`: `string`\[] \| `IncludeFn`<br />`exclude`: `string`\[] \| `IncludeFn`</blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br /><details><summary>`footer`</summary><blockquote>`left`: ActionItems<br />`right`: ActionItems</blockquote></details>`menu`: `StaticMenuItem`\[]<br />`title`: `string`<br />`image`: `string`<br />`logo`: `string` \| `ReactNode`<br /><details><summary>`app`</summary><blockquote>`propTypes`: `WeakValidationMap`&lt;`P`> \| `undefined`<br />`contextTypes`: `ValidationMap`&lt;`any`> \| `undefined`<br />`defaultProps`: `Partial`&lt;`P`> \| `undefined`<br />`displayName`: `string` \| `undefined`</blockquote></details>`copyright`: `string`<br />`language`: `string`<br />`links`: (`DetailedHTMLProps`&lt;>)\[]<br />`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined`<br /><details><summary>`pages`</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>`basePath`\*: <br />`sideNav`\*: <br />`label`\*: <br />`indexHome`\*: <br />`topMenu`\*: <br />`container`\*: <br />`tabs`\*: <br />`navSidebar`\*: <br />`contextSidebar`\*: <br />`fullPage`\*: </blockquote></details></blockquote></details><details><summary>`theme`</summary><blockquote>\[`string`]: `any`</blockquote></details>`storySort`: **function** (<br />`a`\*: `string`<br />`b`\*: `string`<br />) => `number`<br /><details><summary>`toolbar`</summary><blockquote>`left`: ActionItems<br />`right`: ActionItems</blockquote></details>`sidebar`: `ActionItem`\[]<br />`components`: `Record`&lt;`string`, `unknown`><br />`analytics`: `any`<br />`renderFn`: **function** (<br /><details><summary>`props`\*</summary><blockquote><details><summary>`story`\*</summary><blockquote>`name`\*: <br />`storyName`\*: <br />`id`\*: <br />`rawId`\*: <br />`doc`\*: <br />`storyFn`\*: <br />`description`\*: <br />`arguments`\*: <br />`loc`\*: <br />`source`\*: <br />`subtitle`\*: <br />`dynamic`\*: <br />`dynamicId`\*: <br />`component`\*: <br />`subcomponents`\*: <br />`controls`\*: <br />`smartControls`\*: <br />`decorators`\*: <br />`plugins`\*: <br />`category`\*: </blockquote></details><details><summary>`doc`</summary><blockquote>`title`\*: <br />`type`\*: <br />`route`\*: <br />`date`\*: <br />`dateModified`\*: <br />`status`\*: <br />`tags`\*: <br />`keywords`\*: <br />`description`\*: <br />`image`\*: <br />`author`\*: <br />`order`\*: <br />`menu`\*: <br />`template`\*: <br />`stories`\*: <br />`source`\*: <br />`fileName`\*: <br />`package`\*: <br />`testFiles`\*: <br />`testCoverage`\*: <br />`testData`\*: <br />`renderFn`\*: <br />`data`\*: <br />`componentsLookup`\*: <br />`MDXPage`\*: <br />`isMDXComponent`\*: <br />`parameters`\*: <br />`component`\*: <br />`subcomponents`\*: <br />`controls`\*: <br />`smartControls`\*: <br />`decorators`\*: <br />`plugins`\*: <br />`category`\*: <br />`navSidebar`\*: <br />`contextSidebar`\*: <br />`fullPage`\*: </blockquote></details>`values`: ExampleControls<br />`options`: `any`</blockquote></details>) => `any`<br />`webpack`: `Configuration` \| `WebpackConfigFn`<br />`finalWebpack`: `Configuration` \| `WebpackConfigFn`<br />`presets`: `RuleType`\[]<br />`configPath`: `string`<br />`distFolder`: `string`<br />`bundleName`: `string`<br />`staticFolder`: `string`<br />`cssFileName`: `string`<br />`logOptions`: `Partial`&lt;`LogOptions`><br />`mode`: `"none"` \| `"development"` \| `"production"`<br /><details><summary>`loaders`</summary><blockquote>`at`\*: **function** (<br />`index`\*: <br />) => `T` \| `undefined`<br />`module`: `string`</blockquote></details>`stories`: `string` \| `string`\[]<br />`files`: `string` \| `string`\[]<br />`siteRoot`: `string`<br />`ignore`: `string`\[]<br />`categories`: `DocType`\[]<br />`siteMap`: `type` \| `boolean`<br />`siteUrl`: `string`<br />`instrument`: `any`<br /><details><summary>`search`</summary><blockquote>`indexingModule`: `string`<br />`searchingModule`\*: `string`<br />`fields`: `SearchFields`\[]<br />`emptySearchDocuments`: `string`\[]<br />`hitsPerPage`: `number`<br />`options`: `any`</blockquote></details><details><summary>`tokens`</summary><blockquote>`figmaAccessToken`: `string`<br />`githubAccessToken`: `string`</blockquote></details></blockquote></details> | global configuration for config file |

## usePages

**`function`**

Returns an array of all documents in the store

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L75)_

**parameters**

| Name      | Type                 |
| --------- | -------------------- |
| `returns` | (`Document`&lt;>)\[] |

## DocSortOrder

**`union`**

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L80)_

**values**

`"date"` \| `"dateModified"` \| `"title"`

## useThemeState

**`react component`**

Returns the current theme configuration and a setter method

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L100)_

## useControl

**`react function`**

Retruns a controls and a setter function from the current controls context, given a control name

_defined in [@component-controls/store/core/store/src/state/context/controls.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/controls.tsx#L78)_

**parameters**

| Name      | Type               |
| --------- | ------------------ |
| `name`    | `string`           |
| `returns` | \[`T`, `function`] |

## docSortFn

**`function`**

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L82)_

**parameters**

| Name      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sort*`   | [`DocSortOrder`](#docsortorder)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `returns` | <details><summary>`component`</summary><blockquote>\[`string`]: `any`<br />`title`\*: `string`<br />`type`: `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string`<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br /><details><summary>`template`</summary><blockquote>`bind`\*: **function** (<br />`props`: `Story`&lt;`Props`><br />) => `Example`&lt;`Props`><br />`storyName`: `string`<br />`id`: `string`<br />`rawId`: `string`<br />`doc`: `string`<br />`storyFn`: StoryRenderFn<br />`description`: `string`<br /><details><summary>`loc`</summary><blockquote>`start`\*: <br />`end`\*: </blockquote></details>`source`: `string`<br />`subtitle`: `string`<br />`dynamic`: `boolean`<br />`dynamicId`: `string`<br /><details><summary>`component`</summary><blockquote>`at`\*: **function** (<br />`index`\*: `number`<br />) => `T` \| `undefined`</blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`ExampleControls`> \| `any`</blockquote></details></blockquote></details>`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: **function** (<br /><details><summary>`props`\*</summary><blockquote><details><summary>`story`\*</summary><blockquote>`name`\*: <br />`storyName`\*: <br />`id`\*: <br />`rawId`\*: <br />`doc`\*: <br />`storyFn`\*: <br />`description`\*: <br />`arguments`\*: <br />`loc`\*: <br />`source`\*: <br />`subtitle`\*: <br />`dynamic`\*: <br />`dynamicId`\*: <br />`component`\*: <br />`subcomponents`\*: <br />`controls`\*: <br />`smartControls`\*: <br />`decorators`\*: <br />`plugins`\*: <br />`category`\*: </blockquote></details>`doc`: Document<br />`values`: ExampleControls<br />`options`: `any`</blockquote></details>) => `any`<br /><details><summary>`data`</summary><blockquote>\[`string`]: <details><summary>`type`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`ExampleControls`> \| `any`</blockquote></details></blockquote></details><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`&lt;> \| `ComponentControlButton`&lt;> \| `ComponentControlOptions`&lt;> \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`</blockquote></details><details><summary>`smartControls`</summary><blockquote>`smart`: `boolean`<br />`include`: `string`\[] \| `IncludeFn`<br />`exclude`: `string`\[] \| `IncludeFn`</blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details> |

## useCurrentStory

**`react component`**

Returns the currently selected story

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L90)_

## useTheme

**`react component`**

returns current theme object

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L116)_

## useStoryById

**`react function`**

Retrieves a Story object from a story id

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L98)_

**parameters**

| Name       | Type                        |
| ---------- | --------------------------- |
| `storyId*` | `string`                    |
| `returns`  | `Story`&lt;> \| `undefined` |

## ActiveTabContextProvider

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L124)_

**properties**

| Name         | Type                    |
| ------------ | ----------------------- |
| `activeTab*` | `string` \| `undefined` |

## useStoryIdFromName

**`react function`**

given a story name, will go through the store to find a story that matches it

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L106)_

**parameters**

| Name      | Type                    |
| --------- | ----------------------- |
| `name`    | `string`                |
| `returns` | `string` \| `undefined` |

## DocsSortContextProvider

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L110)_

## useActiveTab

**`function`**

Returns the current active tab for documenta that have multiple tabs/pages

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L137)_

**parameters**

| Name      | Type                    |
| --------- | ----------------------- |
| `returns` | `string` \| `undefined` |

## usePackage

**`react function`**

packageId Returns a package object from a package package id. The package id can come from a Document or a Component object.

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L142)_

**parameters**

| Name        | Type                         |
| ----------- | ---------------------------- |
| `packageId` | `string`                     |
| `returns`   | `PackageInfo` \| `undefined` |

## StoryInputProps

**`interface`**

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L122)_

**properties**

| Name   | Type     |
| ------ | -------- |
| `id`   | `string` |
| `name` | `string` |

## useDocSort

**`react function`**

Returns the doc sort order and a setter to update the sort order for a specific doc type

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L129)_

**parameters**

| Name      | Type                                                                    |
| --------- | ----------------------------------------------------------------------- |
| `type*`   | `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string` |
| `returns` | \[[`DocSortOrder`](#docsortorder), `function`]                          |

## useStoryId

**`react component`**

Returns a story id from an input id or story name. The id can be '.', which means the current story.

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L130)_

**properties**

| Name   | Type     | Parent                                |
| ------ | -------- | ------------------------------------- |
| `id`   | `string` | [`StoryInputProps`](#storyinputprops) |
| `name` | `string` | [`StoryInputProps`](#storyinputprops) |

## OptionsContextProvider

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L149)_

**properties**

| Name        | Type                         |
| ----------- | ---------------------------- |
| `userData*` | `Record`&lt;`string`, `any`> |

## useUserData

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/store.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/store.tsx#L160)_

## useStory

**`react component`**

Returns a story from an input id or story name. The id can be '.', which means the current story.

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L145)_

**properties**

| Name   | Type     | Parent                                |
| ------ | -------- | ------------------------------------- |
| `id`   | `string` | [`StoryInputProps`](#storyinputprops) |
| `name` | `string` | [`StoryInputProps`](#storyinputprops) |

## useDocByType

**`function`**

Returns an array of all documents of a specific doc type

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L150)_

**parameters**

| Name      | Type                                                                    |
| --------- | ----------------------------------------------------------------------- |
| `type*`   | `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string` |
| `returns` | (`Document`&lt;>)\[]                                                    |

## useGetDocByType

**`function`**

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L155)_

**parameters**

| Name      | Type                                                                                                                                 |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `returns` | **function** (<br />`type`\*: `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string`<br />) => (`Document`&lt;>)\[] |

## useComponent

**`react component`**

If the \`of\` property is specified, will return the listed component, if \`of\` is not specified, will return the component specified in the component property of the document or the story.

_defined in [@component-controls/store/core/store/src/state/context/components.ts](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/components.ts#L117)_

**properties**

| Name   | Type     | Parent                                        | Description                                                                                                                                                                                                                                                                                        |
| ------ | -------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `of`   | `any`    | [`ComponentInputProps`](#componentinputprops) | Specify the component(s), for which to have information displayed. The default, a value of  `"."`  will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. |
| `name` | `string` | [`ComponentInputProps`](#componentinputprops) | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls                                                                                                                                                    |

## useSortedDocByType

**`function`**

Returns a sorted list of documents of a specific doc type. Uses the sort order state.

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L163)_

**parameters**

| Name      | Type                                                                    |
| --------- | ----------------------------------------------------------------------- |
| `type*`   | `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string` |
| `returns` | (`Document`&lt;>)\[]                                                    |

## useStoryComponent

**`react component`**

Returns a story's component from an input id or story name. The id can be '.', which means the current story.

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L168)_

**properties**

| Name   | Type     | Parent                                |
| ------ | -------- | ------------------------------------- |
| `id`   | `string` | [`StoryInputProps`](#storyinputprops) |
| `name` | `string` | [`StoryInputProps`](#storyinputprops) |

## DocCountType

**`type`**

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L169)_

**properties**

| Name        | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _anonymous_ | \[`string`]: <details><summary>`type`</summary><blockquote>`count`\*: `number`<br /><details><summary>`home`</summary><blockquote>\[`string`]: `any`<br />`title`\*: `string`<br />`type`: DocType<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br />`template`: `Example`&lt;`Props`><br />`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: FrameworkRenderFn<br />`data`: DocumentData<br /><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br /><details><summary>`component`</summary><blockquote>`at`\*: </blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br />`controls`: ComponentControls<br />`smartControls`: SmartControls<br />`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details></blockquote></details><br /> |

## useDocTypeCount

**`function`**

Returns a global object of key/value pairs with counts of documents per doc type

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L174)_

**parameters**

| Name      | Type                            |
| --------- | ------------------------------- |
| `returns` | [`DocCountType`](#doccounttype) |

## useCurrentPropsCount

**`react component`**

returns the number of prop-info properties count for the current document if the current document has more than one component assigned - will return the sum

_defined in [@component-controls/store/core/store/src/state/context/components.ts](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/components.ts#L144)_

## useStoryPath

**`react function`**

Returns a link to a story from a story id.

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L192)_

**parameters**

| Name       | Type     |
| ---------- | -------- |
| `storyId*` | `string` |
| `returns`  | `string` |

## useGetStoryPath

**`function`**

_defined in [@component-controls/store/core/store/src/state/context/story.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/story.tsx#L203)_

**parameters**

| Name      | Type                                                                                    |
| --------- | --------------------------------------------------------------------------------------- |
| `returns` | **function** (<br />`storyId`\*: `string`<br />`activeTab`: `string`<br />) => `string` |

## useNavigationInfo

**`function`**

Returns the next/previous page objects for the current document

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L241)_

**parameters**

| Name      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `returns` | <details><summary>`NavigationResult`</summary><blockquote><details><summary>`nextPage`</summary><blockquote>`link`\*: `string`<br />`title`\*: `string`<br />`type`: `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string`<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br /><details><summary>`template`</summary><blockquote>`bind`\*: <br />`storyName`\*: <br />`id`\*: <br />`rawId`\*: <br />`doc`\*: <br />`storyFn`\*: <br />`description`\*: <br />`loc`\*: <br />`source`\*: <br />`subtitle`\*: <br />`dynamic`\*: <br />`dynamicId`\*: <br />`component`\*: <br />`subcomponents`\*: <br />`smartControls`\*: <br />`decorators`\*: <br />`plugins`\*: <br />`category`\*: <br />`controls`\*: </blockquote></details>`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: **function** (<br />`props`\*: <br />) => `any`<br /><details><summary>`data`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details><details><summary>`prevPage`</summary><blockquote>`link`\*: `string`<br />`title`\*: `string`<br />`type`: `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string`<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br /><details><summary>`template`</summary><blockquote>`bind`\*: <br />`storyName`\*: <br />`id`\*: <br />`rawId`\*: <br />`doc`\*: <br />`storyFn`\*: <br />`description`\*: <br />`loc`\*: <br />`source`\*: <br />`subtitle`\*: <br />`dynamic`\*: <br />`dynamicId`\*: <br />`component`\*: <br />`subcomponents`\*: <br />`smartControls`\*: <br />`decorators`\*: <br />`plugins`\*: <br />`category`\*: <br />`controls`\*: </blockquote></details>`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: **function** (<br />`props`\*: <br />) => `any`<br /><details><summary>`data`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br />`component`: `string` \| `Record`&lt;`string`, `unknown`> \| `ElementType`&lt;`Props`><br />`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details></blockquote></details> |

## useDocumentPath

**`react function`**

Returns a link to a document from a DocType, document id and active tab

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L255)_

**parameters**

| Name         | Type     |
| ------------ | -------- |
| `type*`      |          |
| `docId*`     | `string` |
| `activeTab*` |          |
| `returns`    | `string` |

## useGetDocumentPath

**`function`**

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L265)_

**parameters**

| Name      | Type                                                                                                                          |
| --------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `returns` | **function** (<br />`type`\*: `DocType` \| `undefined`<br />`docId`\*: `string`<br />`activeTab`: `string`<br />) => `string` |

## useDocDescription

**`react function`**

Returns the descript for a document page. It uses the doc.description property if available, or if there is a component assigned to the document will return the component's name.

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L276)_

**parameters**

| Name      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Description                                                                                                                                                                   |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `doc`     | <details><summary>`Document`&lt;></summary><blockquote>\[`string`]: `any`<br />`title`\*: `string`<br />`type`: `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string`<br />`route`: `string`<br />`date`: `string`<br />`dateModified`: `string`<br />`status`: `"draft"` \| `"published"`<br />`tags`: `string`\[]<br />`keywords`: `string`\[]<br />`description`: `string` \| `JSX.Element`<br />`image`: `string`<br />`author`: `string`<br />`order`: `number`<br />`menu`: `string`<br /><details><summary>`template`</summary><blockquote>`bind`\*: <br />`storyName`\*: <br />`id`\*: <br />`rawId`\*: <br />`doc`\*: <br />`storyFn`\*: <br />`description`\*: <br />`loc`\*: <br />`source`\*: <br />`subtitle`\*: <br />`dynamic`\*: <br />`dynamicId`\*: <br />`component`\*: <br />`subcomponents`\*: <br />`smartControls`\*: <br />`decorators`\*: <br />`plugins`\*: <br />`category`\*: <br />`controls`\*: </blockquote></details>`stories`: `string`\[]<br />`source`: `string`<br />`fileName`: `string`<br />`package`: `string`<br />`testFiles`: `string`\[]<br />`testCoverage`: `string`\[]<br />`testData`: `string`<br />`renderFn`: **function** (<br />`props`\*: <br />) => `any`<br /><details><summary>`data`</summary><blockquote>\[`string`]: </blockquote></details><details><summary>`componentsLookup`</summary><blockquote>\[`string`]: `string`</blockquote></details>`MDXPage`: `any`<br />`isMDXComponent`: `boolean`<br />`parameters`: `any`<br /><details><summary>`component`</summary><blockquote>`at`\*: **function** (<br />`index`\*: <br />) => `T` \| `undefined`</blockquote></details>`subcomponents`: `Record`&lt;`string`, (`string`, `Record`&lt;`string`, `unknown`>, `ElementType`&lt;`Props`>)><br /><details><summary>`controls`</summary><blockquote>\[`string`]: `ComponentControl`&lt;`P`></blockquote></details><details><summary>`smartControls`</summary><blockquote>`smart`\*: <br />`include`\*: <br />`exclude`\*: </blockquote></details>`decorators`: `StoryRenderFn`\[]<br />`plugins`: `any`<br />`category`: `string`<br />`navSidebar`: `boolean`<br />`contextSidebar`: `boolean`<br />`fullPage`: `boolean`</blockquote></details> | A documentation file's metadata. For MDX files, fromtmatter is used to declare the document properties. For ESM (ES Modules) documentation files, the default export is used. |
| `returns` | `string` \| `JSX.Element` \| `undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                                                                               |

## useSearch

**`react component`**

_defined in [@component-controls/store/core/store/src/state/context/document.tsx](https://github.com/ccontrols/component-controls/tree/master/core/store/src/state/context/document.tsx#L298)_

<!-- END-API-README -->

---
_Source: https://npm.io/package/@component-controls/store · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._