✅ Done - components documentation in README
burakukula opened this issue · comments
Discussed in https://github.com/contentful/forma-36/discussions/1012
Originally posted by burakukula November 25, 2020
Hey!
For the overview purposes I will add the list of the components that needs README.mdx.
We would like to have consistent docs, please follow this structure:
- Description
- Variations/Overview
- Examples of usage
- Best practices
- Content recommendations (if applying)
- Accessibility (if applying)
There is a command in the components package yarn add-readme that would add the README file with the draft for you.
- Asset #652
- AssetIcon #652
- Accordion
- Autocomplete #666
- Button
- Card
- Checkbox
- CheckboxField #671
- ControlledInput
- ControlledInputField
- CopyButton #652
- DateTime
- Dropdown
- EditorToolbar #652
- EditorToolbarButton #652
- EditorToolbarDivider #652
- EmptyState
- EntityList
- Flex
- Form
- FormLabel
- Grid
- HelpText
- Icon
- IconButton
- Illustration
- InViewport
- List
- Modal
- NavigationIcon → ProductIcon
- Note
- Notification
- Pill
- RadioButton
- RadioButtonField
- RelativeDate
- Select
- SelectField
- Skeleton
- Spinner
- Switch
- TabFocusTrap
- Table
- Tabs
- Tag
- TextField
- TextInput
- TextLink
- Textarea
- ToggleButton
- Tooltip
- Typography
- ValidationMessage
- Workbench
Breaking changes
NO
Done after v4