A next-generation tool to create blazing-fast documentation sites
API
created:3/5/2021
updated:3/5/2021
loc
44
comments
39%
passed
12
coverage
71%

Story

avatar of atanasster
@component-controls/blocks
3.13.1

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)

Commits

Date
Author
Commit Message
4/28/2021

atanasster

avatar of atanasster
fix: add data-testid props
12/28/2020

atanasster

avatar of atanasster
fix: restore story block style
12/28/2020

atanasster

avatar of atanasster
feat: custom esm pages
12/4/2020

atanasster

avatar of atanasster
fix: sx props on story
11/17/2020

atanasster

avatar of atanasster
chore: cleanup default imports of React
10/13/2020

atanasster

avatar of atanasster
fix: story description visibility
10/13/2020

atanasster

avatar of atanasster
feat: initial check in async esm and mdx
8/23/2020

atanasster

avatar of atanasster
feat: jest snapshots initial check-in
7/25/2020

atanasster

avatar of atanasster
chore: remove react context api
7/11/2020

atanasster

avatar of atanasster
fix: workaround new bug in SB RC
33 commits
package
imports
peer
useStoryStoryInputProps
react
^17.0.1
useEffectforwardRefRefFC
*
theme-ui
^0.8.4
jsxCSSProperties
file
imports
"../BlockContainer/story"
StoryBlockContainerStoryBlockContainerProps
"../context"
useCustomProps
"./StoryRender"
StoryRenderStoryWrapperTypeNAME

Stories

Title

controls

Custom Title

My Story Title

Not Collapsible

controls

Description

Components

Iframe