A next-generation tool to create blazing-fast documentation sites
API
created:4/29/2021
updated:4/29/2021
loc
18
comments
17%
passed
28
coverage
75%

ESM

@component-controls/blocks
3.15.0

Component to display a live playground of component examples. Has custom actions for zooming, switch direction, review story source and configuration.

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

Overview

Name
Description
Default
PlaygroundOwnProps(3 properties)
scale

default scale for the zoom feature. If scale is set to 0, the zoom feature will be disabled.

number
-
source

playground source option - valid when a Story is not embedded inside the Playground.

string
-
dark

whether to use the dark theme for the story source component.

boolean
-
BlockContainerOwnProps(6 properties)
HTMLAttributes(42 properties)
Attributes(2 properties)
AriaAttributes(48 properties)
DOMAttributes(161 properties)
-(1 properties)
BoxOwnProps(3 properties)
SpaceProps(28 properties)
BackgroundColorProps(2 properties)
OpacityProps(1 properties)
PanelContainerOwnProps(4 properties)
ActionContainerProps(1 properties)

Commits

Date
Author
Commit Message
9/7/2020

atanasster

avatar of atanasster
feat: docz migration compatibility
8/7/2020

atanasster

avatar of atanasster
chore: linting fixes
7/28/2020

atanasster

avatar of atanasster
docs: initial checkin
7/25/2020

atanasster

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

atanasster

avatar of atanasster
fix: playground context
7/10/2020

atanasster

avatar of atanasster
feat: data-testids
6/30/2020

atanasster

avatar of atanasster
docs: writing mdx stories docs
6/24/2020

atanasster

avatar of atanasster
chore: actionitems node renamed
6/21/2020

atanasster

avatar of atanasster
feat: full text search initial
6/20/2020

atanasster

avatar of atanasster
chore: upgrade to octicons 10.x
36 commits
package
imports
peer
react
^17.0.1
ReactFCChildren
*
file
imports
"./BasePlayground"
BasePlaygroundPlaygroundProps
"./StoryPlayground"
StoryPlayground

Stories

Default Open Source

Disable Zoom Pan

Multi Stories

Components

Title

story

description of story

Components

Custom Title

Custom playground title

Not Collapsible

Extra Panel

Child

My donut example

Multi Child

Multiple donuts

Dark Theme

Scale

Zoom Disabled

Visible Tabs