Documentation for the Tabs Control (#904)
* Added docs for Tabs * Update Tabs.mdx * Update Tabs.mdx * Update Tabs.mdx * Adding more tokens * Sorting tokens
This commit is contained in:
Родитель
35c28dcb6a
Коммит
7e4df7ce9a
|
@ -0,0 +1,66 @@
|
|||
# Tabs
|
||||
|
||||
## Purpose
|
||||
|
||||
The Tabs control and related tabs pattern are used for navigating frequently accessed, distinct content categories. Tabs allow for navigation between two or more content views and relies on text headers to articulate the different sections of content.
|
||||
Selecting a tab item header navigates to that header's section content.
|
||||
|
||||
## Do's:
|
||||
|
||||
- Use on content-heavy views that require a significant amount of scrolling to access the various sections.
|
||||
- Be concise on the navigation header texts, ideally one or two words rather than a phrase.
|
||||
- Make sure all the children of the Tabs component are of type TabItem.
|
||||
|
||||
## Don't:
|
||||
|
||||
- Nest with other RadioGroup or Checkboxes. If possible, keep all the options at the same level.
|
||||
- Use on Views which don’t scroll.
|
||||
- Use the Tabs to access a different global view.
|
||||
- Use the Tabs to access hidden content.
|
||||
- Pass any children of type other than TabItem to the Tabs component.
|
||||
|
||||
## Sample Code:
|
||||
|
||||
```jsx
|
||||
<Tabs>
|
||||
<TabsItem headerText="Home" itemKey="A">
|
||||
<Text>Tabs #1</Text>
|
||||
</TabsItem>
|
||||
<TabsItem headerText="Files" itemKey="B">
|
||||
<Text>Tabs #2</Text>
|
||||
</TabsItem>
|
||||
<TabsItem headerText="Settings" itemKey="C">
|
||||
<Text>Tabs #3</Text>
|
||||
</TabsItem>
|
||||
</Tabs>
|
||||
```
|
||||
|
||||
## Tokens:
|
||||
|
||||
Tabs supports the following tokens:
|
||||
|
||||
1. backgroundColor – This changes the background color of Tabs.
|
||||
2. color – This changes the text color of the label associated with Tabs.
|
||||
3. fontFamily – This changes the font family of the label associated with Tabs.
|
||||
4. fontSize – This changes the font size of the label associated with Tabs.
|
||||
5. fontWeight – This changes the font weight of the label associated with Tabs.
|
||||
6. variant – This sets the styling of Tabs to a specific configuration.
|
||||
|
||||
TabsItem supports the following tokens:
|
||||
|
||||
1. backgroundColor – This changes the background color of the TabsItem.
|
||||
2. borderColor – This changes the border color of the TabsItem.
|
||||
3. borderRadius – This changes the border radius of the TabsItem.
|
||||
4. borderStyle – This changes the border style of the TabsItem.
|
||||
5. borderWidth – This changes the border width of the TabsItem.
|
||||
6. color – This changes the text color of the header associated with the TabsItem.
|
||||
7. fontFamily – This changes the font family of the header associated with the TabsItem.
|
||||
8. fontSize – This changes the font size of the header associated with the TabsItem.
|
||||
9. fontWeight – This changes the font weight of the header associated with the TabsItem.
|
||||
10. headerText – This sets the text to show on the TabsItem.
|
||||
11. headerTextPadding – This changes the amount of padding between the border and the headerText.
|
||||
12. headerTextPaddingFocused – This changes the amount of padding between the border and the headerText when the TabsItem has focus.
|
||||
13. icon – This sets the icon to show on the TabsItem.
|
||||
14. iconColor – This changes the color of the TabsItem’s icon.
|
||||
15. indicatorColor – This changes the color of the TabsItem's selected indicator.
|
||||
16. variant – This sets the styling of the TabsItem to a specific configuration.
|
Загрузка…
Ссылка в новой задаче