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

Story

@component-controls/blocks
2.11.3

block component to render story function with decorators

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

Overview

Name
Description
Default
StoryOwnProps (4 properties)
ref

ref can be used by blocks embedding Story - ie ally plugin

((instance: HTMLDivElement | null) => void) | RefObject<HTMLDivElement> | null
-
onRender

used by other blocks ie ally plugin uses it launch a new ally test on re-render

(() => void)
-
wrapper

wrapper type - can be an iframe or just regular react

iframewrapper
-
iframeStyle

if an iframe wrapper - this is additional iframe style

CSSProperties
-
StoryInputProps (2 properties)
BlockContainerOwnProps (5 properties)
HTMLAttributes (42 properties)
Attributes (2 properties)
AriaAttributes (48 properties)
DOMAttributes (161 properties)
BoxOwnProps (3 properties)
SpaceProps (28 properties)
BackgroundColorProps (2 properties)
OpacityProps (1 properties)

package
imports
peer
useStoryStoryInputProps
react
^17.0.1
useEffectforwardRefRefFC
*
theme-ui
^0.6.0-alpha.7
jsxCSSProperties

file
imports
"../BlockContainer/story"
StoryBlockContainerStoryBlockContainerProps
"../context"
useCustomProps
"./StoryRender"
StoryRenderStoryWrapperTypeNAME

Stories

Title

controls

Custom Title

My Story Title

Not Collapsible

controls

Description

Components

Iframe