Skip to content

Commit

Permalink
docs: update blocks docs
Browse files Browse the repository at this point in the history
  • Loading branch information
atanasster committed Mar 22, 2020
1 parent 760ba21 commit 0a24d85
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Third-libraries used in no particular order:
- [react-popper-tooltip](https://react-popper-tooltip.netlify.com) for popups and tooltips.
- [react-animate-height](https://muffinman.io/react-animate-height/) for collapsible components.
- [@theme-ui/presets](https://theme-ui.com/packages/presets/) for custom theming.
- [react-switch](https://github.com/markusenglund/react-switch) for toggle editor
- [react-switch](https://github.com/markusenglund/react-switch) for toggle/boolean inputs.

<!-- END-PACKAGE-SECTION -->

Expand Down Expand Up @@ -88,9 +88,11 @@ A collection of core block components - intended to be displayed on the document

Some of the guiding design goals for this library:

- Most components should have a 'plain' and a 'block' version, where the block versions adds a collapsible ox with a title.
- There are two main categories of components: components that display story data (i.e. story source, story render) and component(s) data (i.e. prop tables, component sources)
- All components accept a list of custom ActionItems to be extended.
- The compnents that deal with source code (sotory or component) display actions to visit the repositories.
- 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.
- Compnents that deal with source code (story or component source) display actions to browse their respective repositories.

<!-- END-PACKAGE-SECTION -->
10 changes: 9 additions & 1 deletion ui/blocks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,12 +310,18 @@ _BlockStorySource [source code](https:/github.com/ccontrols/component-controls/b

## <ins>StorySource</ins>

Display source code of a story. If controls are used, all story arguments will be highlighted. Additional commands are made available if the repository data of the story is available.
Display source code of a story.
If controls are used, all story arguments will be highlighted.
Additional commands are made available if the repository data of the story is available.

_StorySource [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/StorySource/plain/StorySource.tsx)_

## <ins>Subtitle</ins>

displays a subtitle as assigned to the story parameters:
story.parameters.componentSubtitle
or story.subtitle

_Subtitle [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/Subtitle/Subtitle.tsx)_

**Properties:**
Expand All @@ -334,6 +340,8 @@ _Subtitle [source code](https:/github.com/ccontrols/component-controls/blob/mast

## <ins>Title</ins>

displays a title as assigned to the story document

_Title [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/Title/Title.tsx)_

**Properties:**
Expand Down

0 comments on commit 0a24d85

Please sign in to comment.