wix-storybook-utils
Version:
Utilities for automated component documentation within Storybook
79 lines (78 loc) • 2.59 kB
JSON
{
"description": "Radio button represents an item of a single selection list. It is a part of RadioGroup or can be used to recreate it.",
"do": [],
"dont": [],
"featureExamples": [
{
"title": "Structure",
"description": "Radio button consists of a radio itself and a label on the side.",
"example": "_structure"
},
{
"title": "States",
"description": "Radio button has three states - `default`, `checked` and `disabled`.",
"example": "_states"
},
{
"title": "Label",
"description": "Label value accepts `node` or `string` based values. It is recommended to use `string` as it complies with design systems typography.",
"example": "_label"
},
{
"title": "Alignment",
"description": "Radio is vertically centered to its label by default. Items can be aligned to the top with alignItems prop.",
"example": "_alignment"
},
{
"title": "Advanced Example",
"description": "Radio can be used to recreate Radio Group.",
"example": "_advancedRadioGroup"
},
{
"title": "Advanced Example",
"description": "Radio can be used to build custom selection lists.",
"example": "_advancedCustomSelection"
}
],
"developerExamples": [
{
"title": "Structure",
"description": "Radio button consists of a radio itself and a label on the side.",
"example": "_structure"
}
],
"accessibilityExamples": [
{
"title": "Structure",
"description": "Radio button consists of a radio itself and a label on the side.",
"example": "_structure"
}
],
"includedComponents": [
{ "category": "StorybookUI", "title": "Text", "optional": true },
{ "category": "StorybookUI", "title": "Heading" }
],
"commonUseCaseExamples": [
{
"title": "Structure",
"description": "Radio button consists of a radio itself and a label on the side.",
"example": "_structure",
"wide": true
},
{
"title": "States",
"description": "Radio button has three states - `default`, `checked` and `disabled`.",
"example": "_states"
},
{
"title": "Label",
"description": "Label value accepts `node` or `string` based values. It is recommended to use `string` as it complies with design systems typography.",
"example": "_label"
},
{
"title": "Alignment",
"description": "Radio is vertically centered to its label by default. Items can be aligned to the top with alignItems prop.",
"example": "_alignment"
}
]
}