A next-generation tool to create blazing-fast documentation sites
API
created:3/5/2021
updated:3/5/2021
source lines:77
comments %:32

BlockContainer

@component-controls/components
3.6.1

Collapsible block container with a title. The title creates also an attribute id and an octicon for github style navigation.

import { BlockContainer } from '@component-controls/components';

Overview

Block title

Name
Description
Default
Controls
title

optional section title for the block.

string
-

Name
Description
Default
BlockContainerOwnProps (6 properties)
title

optional section title for the block.

string
-
description

optional markdown description.

string
-
id

optional id to be used for the block if no id is provided, one will be calculated automatically from the title.

string
-
collapsible

if false, will nothave a collapsible frame.

boolean
true
data-testid

testing id

string
-
plain

inner container variant or plain

boolean
false
HTMLAttributes (42 properties)
Attributes (1 properties)
AriaAttributes (48 properties)
DOMAttributes (161 properties)
- (1 properties)
BoxOwnProps (4 properties)
SpaceProps (28 properties)
BackgroundColorProps (2 properties)
OpacityProps (1 properties)

Commits

Date
Author
Commit Message
2/17/2021

atanasster

feat: components history and catalog
12/29/2020

atanasster

fix: link when no id prop
12/28/2020

atanasster

fix: restore story block style
12/28/2020

atanasster

feat: custom esm pages
12/8/2020

atanasster

fix: plain prop
12/8/2020

atanasster

docs: update blog content
12/3/2020

atanasster

fix: sx prop upgrade
12/1/2020

atanasster

docs: update story mock contexts
11/30/2020

atanasster

feat: component jsx explorer
11/17/2020

atanasster

chore: cleanup default imports of React
39 commits

package
imports
peer
ChevronRightIconChevronDownIcon
react
^17.0.1
useStateFC
*
theme-ui
^0.6.0-alpha.7
jsxTextLinkFlexDividerBoxPropsBox

file
imports
"../Collapsible"
Collapsible
"../LinkHeading"
"../Description"

Stories

Not Collapsible

BlockContainer

Custom Id

BlockContainer

Description

H3 title

Markdown

google