A next-generation tool to create blazing-fast documentation sites
API
created:3/3/2020
,
updated:2/17/2021

Description

@component-controls/blocks
2.11.3

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 a link

Name
Description
Default
components

components to customize the markdown display.

{ [key: string]: string | ComponentClass<any, any> | SFC<any> | { component: string | ComponentClass<any, any> | SFC<any>; props?: any; }; ... 30 more ...; ul?: string | ... 3 more ... | 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
-

package
imports
peer
MarkdownPropsDescription
useCurrentDocumentuseComponentsComponentInputProps
react
^17.0.1
ReactFC
*

file
imports
"../BlockContainer/components/ComponentsContainer"
ComponentsContainer

Stories

Components

Markdown descripton for component.

custom component: With a heading

and a link