A next-generation tool to create blazing-fast documentation sites
API
created:3/5/2021
updated:3/5/2021
loc
37
comments
11%
passed
4
coverage
64%

Description

avatar of atanasster
@component-controls/blocks
3.13.1

Description component with markdown. The 'of' property can specify which component's description to display.

import { Description } from '@component-controls/blocks';

Overview

Markdown descripton for component. # With a heading and some bold text

Name
Description
Default
components

components to customize the markdown display.

{ [key: string]: ComponentOverride<any, any>; a?: ComponentOverride<any, any> | undefined; br?: ComponentOverride<any, any> | undefined; ... 28 more ...; ul?: ComponentOverride<...> | undefined; } | undefined
-
of
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.
any
-
name

some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls

string
-

Commits

Date
Author
Commit Message
11/15/2020

atanasster

avatar of atanasster
feat: bind templates to stories
10/13/2020

atanasster

avatar of atanasster
fix: update jest tests and tests
8/9/2020

atanasster

avatar of atanasster
fix: add doc description to Description
7/25/2020

atanasster

avatar of atanasster
chore: refactor containers folders
7/25/2020

atanasster

avatar of atanasster
chore: remove react context api
3/21/2020

atanasster

avatar of atanasster
docs: update Description component
3/17/2020

atanasster

avatar of atanasster
feat: componet context handle subcomponents
3/17/2020

atanasster

avatar of atanasster
chore: separate component and story contexts
3/8/2020

atanasster

avatar of atanasster
chore: move components
3/3/2020

atanasster

avatar of atanasster
feat: add description block
10 commits
package
imports
peer
MarkdownPropsDescription
useCurrentDocumentuseComponentsComponentInputProps
react
^17.0.1
ReactFC
*
file
imports
"../BlockContainer/components/ComponentsContainer"
ComponentsContainer

Stories

Components

Markdown descripton for component. # With a heading and some bold text