created:3/15/2021
updated:3/15/2021
source lines:77
comments %:32
BlockContainer
Collapsible block container with a title. The title creates also an attribute id and an octicon for github style navigation.
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) |
package | imports | peer |
---|---|---|
@primer/octicons-react ^10.0.0 | ChevronRightIconChevronDownIcon | |
react ^17.0.1 | useStateFC | * |
theme-ui ^0.6.0-alpha.7 | jsxTextLinkFlexDividerBoxPropsBox |
file | imports |
---|---|
"../Collapsible" | |
"../LinkHeading" | |
"../Description" |