4.0.3 • Published 2 years ago

@component-controls/blocks v4.0.3

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

Table of contents

Overview

Some of the guiding design goals for this library:

  • Most components should have a 'plain' and a 'block' version, where the block version adds a collapsible Box with a title.
  • There are two main categories of components:
    • that display story data (i.e. story source, story render)
    • that display component(s) data (i.e. prop tables, component sources)
  • Components accept a list of custom ActionItems to be extended.
  • Components that deal with source code (story or component source) display actions to browse their respective repositories.

List of components

getURL

react component

defined in @component-controls/blocks/ui/blocks/src/utils/url.ts

InvalidType

react component

error message when the control type is not found.

defined in @component-controls/blocks/ui/blocks/src/notifications/InvalidType.tsx

getStoryTitle

react type

defined in @component-controls/blocks/ui/blocks/src/utils/constants.ts

properties

NameTypeParentDescription
title*stringDocumenttitle of the document. If no 'route' parameter is specifified, the title is used to generate the document url. This is the only required field, to show the document in the menu structures.
type"story" | "blog" | "page" | "tags" | "author" | stringDocumentdocument type - blogs, pages, stories and even custom ones. By default - story
routestringDocumentif provided, will be used as the route for the page. if not provided, the title in lowercase will be used as the route
datestringDocumentoptional date the document was created. If not assigned, the instrumentation process will use birthtime
dateModifiedstringDocumentoptional date the document was last modified. If not assigned, the instrumentation process will use mtime
status"draft" | "published"Documentif set to draft, the document will be hidden in production builds.
tagsstring[]Documentcomma-separated list of document tags, used for search and for SOE keywords unless keyswords are specified.
keywordsstring[]Documentcomma-separated list of SEO keywords
descriptionstring | JSX.ElementDocumentdocumentation file description
imagestringDocumentlink to an image for the document, will be used for SEO
authorstringDocumentdocument author
ordernumberDocumentdocument order, used to sort documents within the same parent
menustringDocumentto which static menu to attach the document compatibility with docz
templatetypebind*: function (propsname*: 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: string) => Example<>bind*: function (props*: ) => Example<Props>source: stringid: stringdescription: stringstoryName: stringrawId: stringdoc: stringstoryFn: StoryRenderFnloc: CodeLocationsubtitle: stringdynamic: booleandynamicId: stringcomponentat*: subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>smartControls: SmartControlsdecorators: StoryRenderFn[]plugins: anycategory: stringcontrols*: source: stringid: stringdescription: stringstoryName: stringrawId: stringdoc: stringstoryFn: function (controlValues[string]: anycontext: any) => Promise | anylocstart*line*: numbercolumn*: numberend*line*: numbercolumn*: numbersubtitle: stringdynamic: booleandynamicId: stringcomponent: string | Record<string, unknown> | ElementType<Props>subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>smartControlssmart: booleaninclude: string[] | IncludeFnexclude: string[] | IncludeFndecorators: StoryRenderFn[]plugins: anycategory: stringcontrols[string]: ComponentControl<ExampleControls> | anyDocumenttemplate component to be linked to document stories
storiesstring[]Documentlist of story ids contained in the document.
sourcestringDocumentsource code of the entire file of stories
fileNamestringDocumentfile name of the file of stories
packagestring
@component-controls/components@component-controls/core@component-controls/editors@component-controls/render@component-controls/search-algolia@component-controls/store@primer/octicons-react@theme-ui/cssansi_upcopy-to-clipboardglobaljs-string-escapequery-stringreactreact-error-boundaryreact-frame-componentreact-resize-detectorstringify-objecttheme-ui
@infinitebrahmanuniverse/nolb-_compo@everything-registry/sub-chunk-193@zalastax/nolb-_compo@component-controls/pages@component-controls/figma-embed@component-controls/viewport-plugin@component-controls/app@component-controls/axe-plugin@component-controls/addon-catalog@component-controls/addon-images@component-controls/addon-notes@component-controls/addon-stats@component-controls/storybook
4.0.3

2 years ago

3.15.0

3 years ago

3.13.1

3 years ago

3.12.0

3 years ago

3.14.1

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.4

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.1

3 years ago

3.9.0

3 years ago

3.10.1

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.3

3 years ago

3.8.2

3 years ago

3.8.1

3 years ago

3.11.0

3 years ago

3.7.0

3 years ago

3.11.2

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.1

3 years ago

3.6.0

3 years ago

3.5.5

3 years ago

3.5.4

3 years ago

3.5.3

3 years ago

3.5.2

3 years ago

3.5.1

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.1

3 years ago

2.5.0

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.9

3 years ago

1.42.6

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.3

3 years ago

1.40.5

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

3 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.5

4 years ago

1.36.6

4 years ago

1.36.4

4 years ago

1.36.3

4 years ago

1.36.2

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.5

4 years ago

1.19.3

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.1

4 years ago

1.13.3

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.1

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