4.0.3 • Published 2 years ago

@component-controls/store v4.0.3

Weekly downloads
887
License
MIT
Repository
github
Last release
2 years ago

Table of contents

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

Installation

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

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

API

ControlUpdateFn

function

defined in @component-controls/store/core/store/src/state/context/controls.tsx

parameters

NameType
name*string | undefined
newValue*any

StoreContext

interface

defined in @component-controls/store/core/store/src/state/context/store.tsx

properties

NameTypeParent
Provider*typepropTypes: WeakValidationMap<> | undefined$$typeof*: Context
Consumer*type$$typeof*: Context
displayNamestring | undefinedContext

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

parameters

NameType
category*string
returnsDocCountType

ComponentInputProps

interface

defined in @component-controls/store/core/store/src/state/context/components.ts

properties

NameTypeDescription
ofanySpecify 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.
namestringsome 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

properties

NameTypeDescription
controlsComponentControls<>[string]: ComponentControlText | ComponentControlBoolean | ComponentControlColor | ComponentControlDate | ComponentControlObject<> | ComponentControlButton<> | ComponentControlOptions<> | ComponentControlNumber | ComponentControlArray | ComponentControlFilesComponentControls are defined in key value pairs the name of the property is the key and the value is the ComponentControl
updateValue*ControlUpdateFn

StoreContextProvider

react component

defined in @component-controls/store/core/store/src/state/context/store.tsx

properties

NameType
store*Storeerror: stringconfig*author: stringcontrols[string]: ComponentControl<P>description: stringcomponent: string | Record<string, unknown> | ElementType<Props>subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>smartControlssmart*: include*: exclude*: decorators: StoryRenderFn[]plugins: anycategory: stringfooterleft*: right*: menu: StaticMenuItem[]title: stringimage: stringlogo: string | ReactNodeapppropTypes*: contextTypes*: defaultProps*: displayName*: copyright: stringlanguage: stringlinks: (DetailedHTMLProps<>)[]seo: ReactChild | ReactFragment | ReactPortal | boolean | null | undefinedpages[string]: theme[string]: anystorySort: function (a*: stringb*: string) => numbertoolbarleft*: right*: sidebar: ActionItem[]components: Record<string, unknown>analytics: anyrenderFn: function (props*story*: doc*: values*: options*: ) => anywebpack: Configuration | WebpackConfigFnfinalWebpack: Configuration | WebpackConfigFnpresets: RuleType[]configPath: stringdistFolder: stringbundleName: stringstaticFolder: stringcssFileName: stringlogOptions: Partial<LogOptions>mode: "none" | "development" | "production"loadersat*: module*: ident*: loader*: options*: stories: string | string[]files: string | string[]siteRoot: stringignore: string[]categories: DocType[]siteMap: type | booleansiteUrl: stringinstrument: anysearchindexingModule*: searchingModule*: fields*: emptySearchDocuments*: hitsPerPage*: options*: tokensfigmaAccessToken*: githubAccessToken*: docs*[string]: type[string]: anytitle*: stringtype: DocTyperoute: stringdate: stringdateModified: stringstatus: "draft" | "published"tags: string[]keywords: string[]description: string | JSX.Elementimage: stringauthor: stringorder: numbermenu: stringtemplate: Example<Props>stories: string[]source: stringfileName: stringpackage: stringtestFiles: string[]testCoverage: string[]testData: stringrenderFn: FrameworkRenderFndata: DocumentDatacomponentsLookup[string]: stringMDXPage: anyisMDXComponent: booleanparameters: anycomponentat*: subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>controls: ComponentControlssmartControls: SmartControlsdecorators: StoryRenderFn[]plugins: anycategory: stringnavSidebar: booleancontextSidebar: booleanfullPage: booleanstories*[string]: typename*: stringstoryName: stringid: stringrawId: stringdoc: stringstoryFn: StoryRenderFndescription: stringarguments: StoryArgumentsloc: CodeLocationsource: stringsubtitle: stringdynamic: booleandynamicId: stringcomponentat*: subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>controls: ComponentControlssmartControls: SmartControlsdecorators: StoryRenderFn[]plugins: anycategory: stringcomponents*[string]: interfacename*: stringimportedName: "default" | "namespace" | stringfrom: stringrequest: stringfileName: stringpropsInfoFile: stringloc: CodeLocationpackage: stringsource: stringinfo: ComponentInfoexternalDependencies: ImportslocalDependencies: Importsjsx: JSXTreefileInfo: FileInfojest: JestTestspackages*[string]: interfacefileHash*: stringname: stringversion: stringdependencies: PackageDependenciesdevDependencies: PackageDependenciespeerDependencies: PackageDependenciesprivateNpm: booleanrepository*browse*: docs*: issues*: addObserver*: function (observer*: function (story: Story) => void) => voidremoveObserver*: function (observer*: function (story: Story) => void) => voidupdateStory*: function (story*name*: stringstoryName: stringid: stringrawId: stringdoc: stringstoryFn: StoryRenderFndescription: stringarguments: StoryArgumentsloc: CodeLocationsource: stringsubtitle: stringdynamic: booleandynamicId: stringcomponent: string | Record<string, unknown> | ElementType<Props>subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>controls: ComponentControlssmartControls: SmartControlsdecorators: StoryRenderFn[]plugins: anycategory: string) => voidsearch: function (store*error*: config*: docs*: stories*: components*: packages*: addObserver*: removeObserver*: updateStory*: search*: ) => SearchResultitems*: SearchItem[]searchFn*: function (search*: ) => voidproviderlogo*: url*: name*:

StateRootProps

interface

defined in @component-controls/store/core/store/src/state/context/StateRoot.tsx

properties

NameTypeDescription
storyIdstringcurrent story id
docIdstring
@analytics/google-analytics@component-controls/core@component-controls/loader@component-controls/logger@component-controls/renderanalyticsbroadcast-channelpathrecoiltypescript
@infinitebrahmanuniverse/nolb-_compo@everything-registry/sub-chunk-193@zalastax/nolb-_compo@component-controls/addon-catalog@component-controls/addon-images@component-controls/addon-notes@component-controls/app@component-controls/axe-plugin@component-controls/base-integration@component-controls/blocks@component-controls/cc-cli@component-controls/editors@component-controls/figma-embed@component-controls/jest-snapshots@component-controls/storybook@component-controls/webpack-configs
4.0.3

2 years ago

3.15.0

3 years ago

3.12.0

3 years ago

3.14.0

3 years ago

3.14.3

3 years ago

3.14.2

3 years ago

3.14.5

3 years ago

3.14.6

3 years ago

3.13.0

3 years ago

3.11.4

3 years ago

3.11.3

3 years ago

3.9.0

3 years ago

3.8.0

3 years ago

3.10.0

3 years ago

3.10.3

3 years ago

3.10.2

3 years ago

3.8.2

3 years ago

3.11.0

3 years ago

3.7.0

3 years ago

3.11.1

3 years ago

3.10.4

3 years ago

3.6.3

3 years ago

3.6.2

3 years ago

3.6.0

3 years ago

3.5.3

3 years ago

3.5.2

3 years ago

3.5.0

3 years ago

3.4.4

3 years ago

3.4.3

3 years ago

3.4.5

3 years ago

3.4.2

3 years ago

3.4.1

3 years ago

3.4.0

3 years ago

3.2.0

3 years ago

3.1.6

3 years ago

3.1.5

3 years ago

3.1.4

3 years ago

3.3.0

3 years ago

3.1.3

3 years ago

3.1.2

3 years ago

3.1.1

3 years ago

3.1.0

3 years ago

2.13.0

3 years ago

2.12.0

3 years ago

2.11.3

3 years ago

2.11.2

3 years ago

2.11.0

3 years ago

2.11.1

3 years ago

2.10.5

3 years ago

2.10.4

3 years ago

2.10.3

3 years ago

2.10.2

3 years ago

2.10.1

3 years ago

2.10.0

3 years ago

2.9.1

3 years ago

2.9.0

3 years ago

2.8.1

3 years ago

2.8.0

3 years ago

2.7.0

3 years ago

2.6.5

3 years ago

2.6.4

3 years ago

2.6.3

3 years ago

2.6.2

3 years ago

2.6.1

3 years ago

2.6.0

3 years ago

2.5.3

3 years ago

2.5.2

3 years ago

2.5.0

3 years ago

2.5.1

3 years ago

2.4.1

3 years ago

2.4.0

3 years ago

2.4.2

3 years ago

2.3.0

3 years ago

2.2.4

3 years ago

2.2.3

3 years ago

2.2.1

3 years ago

2.2.0

3 years ago

2.1.0

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

1.44.1

3 years ago

1.44.0

3 years ago

1.43.0

3 years ago

1.42.12

3 years ago

1.42.6

3 years ago

1.42.9

3 years ago

1.42.4

3 years ago

1.42.2

3 years ago

1.42.1

3 years ago

1.41.1

3 years ago

1.42.0

3 years ago

1.41.0

3 years ago

1.40.4

3 years ago

1.40.5

3 years ago

1.40.3

3 years ago

1.40.2

3 years ago

1.40.1

3 years ago

1.39.3

3 years ago

1.39.4

3 years ago

1.39.2

3 years ago

1.39.0

3 years ago

1.38.2

3 years ago

1.38.0

4 years ago

1.37.0

4 years ago

1.36.14

4 years ago

1.36.13

4 years ago

1.36.12

4 years ago

1.36.11

4 years ago

1.36.8

4 years ago

1.36.7

4 years ago

1.36.6

4 years ago

1.36.5

4 years ago

1.36.4

4 years ago

1.36.2

4 years ago

1.36.3

4 years ago

1.36.1

4 years ago

1.36.0

4 years ago

1.35.1

4 years ago

1.35.0

4 years ago

1.34.0

4 years ago

1.33.1

4 years ago

1.32.1

4 years ago

1.32.4

4 years ago

1.32.5

4 years ago

1.32.2

4 years ago

1.32.3

4 years ago

1.31.3

4 years ago

1.31.2

4 years ago

1.30.0

4 years ago

1.29.0

4 years ago

1.28.0

4 years ago

1.27.3

4 years ago

1.27.2

4 years ago

1.27.1

4 years ago

1.27.0

4 years ago

1.26.0

4 years ago

1.25.3

4 years ago

1.25.2

4 years ago

1.25.1

4 years ago

1.25.0

4 years ago

1.24.7

4 years ago

1.24.6

4 years ago

1.24.5

4 years ago

1.24.3

4 years ago

1.24.2

4 years ago

1.24.1

4 years ago

1.24.0

4 years ago

1.23.0

4 years ago

1.22.0

4 years ago

1.22.1

4 years ago

1.21.0

4 years ago

1.20.0

4 years ago

1.19.4

4 years ago

1.19.3

4 years ago

1.19.5

4 years ago

1.19.2

4 years ago

1.19.1

4 years ago

1.19.0

4 years ago

1.18.1

4 years ago

1.18.0

4 years ago

1.18.3

4 years ago

1.18.2

4 years ago

1.17.0

4 years ago

1.16.3

4 years ago

1.16.2

4 years ago

1.16.1

4 years ago

1.16.0

4 years ago

1.15.0

4 years ago

1.14.1

4 years ago

1.14.0

4 years ago

1.14.4

4 years ago

1.14.3

4 years ago

1.14.2

4 years ago

1.13.4

4 years ago

1.13.2

4 years ago

1.13.3

4 years ago

1.13.1

4 years ago

1.12.0

4 years ago

1.11.2

4 years ago

1.11.1

4 years ago

1.11.0

4 years ago

1.10.4

4 years ago

1.10.3

4 years ago

1.10.2

4 years ago

1.10.1

4 years ago

1.10.0

4 years ago

1.9.0

4 years ago

1.8.0

4 years ago

1.7.1

4 years ago

1.7.0

4 years ago

1.6.0

4 years ago

1.5.7

4 years ago

1.5.6

4 years ago

1.5.5

4 years ago

1.5.4

4 years ago

1.5.3

4 years ago

1.5.2

4 years ago

1.5.1

4 years ago

1.5.0

4 years ago

1.4.0

4 years ago

1.3.0

4 years ago

1.2.0

4 years ago

1.1.0

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

0.9.0

4 years ago

0.8.2

4 years ago

0.8.0

4 years ago

0.7.5

4 years ago

0.7.4

4 years ago

0.7.3

4 years ago

0.7.2

4 years ago

0.7.1

4 years ago

0.7.0

4 years ago