Skip to content

[material-ui][docs] Improve TabContext, TabList, and TabPanel documentation #40587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DiegoAndai merged 3 commits into from
Jan 17, 2024
Merged

[material-ui][docs] Improve TabContext, TabList, and TabPanel documentation #40587

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7bf39b
Update tabs.md
anle9650 Jan 14, 2024
090561d
Update tabs.md
anle9650 Jan 14, 2024
dd7a7e7
move lab components to Experimental API
anle9650 Jan 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions docs/data/material/components/tabs/tabs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,30 @@ Tabs organize and allow navigation between groups of content that are related an

{{"component": "modules/components/ComponentLinkHeader.js"}}

## Basic tabs
## Introduction

A basic example with tab panels.
Tabs are implemented using a collection of related components:

- `<Tab />` - the tab element itself. Clicking on a tab displays its corresponding panel.
- `<Tabs />` - the container that houses the tabs. Responsible for handling focus and keyboard navigation between tabs.

{{"demo": "BasicTabs.js"}}

## Basics

```jsx
import Tabs from '@mui/material/Tabs';
import Tab from '@mui/material/Tab';
```

## Experimental API

`@mui/lab` offers utility components that inject props to implement accessible tabs
following [WAI-ARIA authoring practices](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/).
following [WAI-ARIA authoring practices](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/):

- `<TabList />` - the container that houses the tabs. Responsible for handling focus and keyboard navigation between tabs.
- `<TabPanel />` - the card that hosts the content associated with a tab.
- `<TabContext />` - the top-level component that wraps the Tab List and Tab Panel components.

{{"demo": "LabTabs.js"}}

Expand Down