TabsAPI
React Tabs 组件的 API 参考文档。了解此导出的模块的 props、CSS 和其他 API。
演示
导入
import Tabs from '@mui/material/Tabs';
// or
import { Tabs } from '@mui/material';
通过阅读此关于最小化 bundle size 的指南,了解它们之间的区别。
原生组件的 Props 也可用。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
action | ref | - | 当组件挂载时触发的回调。当您想要以编程方式触发操作时,这非常有用。它支持两个操作: |
allowScrollButtonsMobile | bool | false | 如果为 |
aria-label | string | - | Tabs 的标签字符串。 |
aria-labelledby | string | - | 一个 id 或以空格分隔的 id 列表,用于标记 Tabs。 |
centered | bool | false | 如果为 |
children | node | - | 组件的内容。 |
classes | object | - | 覆盖或扩展应用于组件的样式。 有关更多详细信息,请参见下方的 CSS 类 API。 |
component | elementType | - | 用于根节点的组件。可以是用于 HTML 元素的字符串,也可以是组件。 |
indicatorColor | 'primary' | 'secondary' | string | 'primary' | 确定指示器的颜色。 |
onChange | func | - | 当值更改时触发的回调。 签名: function(event: React.SyntheticEvent, value: any) => void
|
orientation | 'horizontal' | 'vertical' | 'horizontal' | 组件方向(布局流方向)。 |
ScrollButtonComponent | elementType | TabScrollButton | 用于渲染滚动按钮的组件。 |
scrollButtons | 'auto' | false | true | 'auto' | 确定当选项卡设置为滚动时滚动按钮的行为
默认情况下,滚动按钮在移动设备上是隐藏的。可以使用 |
selectionFollowsFocus | bool | - | 如果为 |
slotProps | { endScrollButtonIcon?: func | object, indicator?: func | object, list?: func | object, root?: func | object, scrollbar?: func | object, scrollButtons?: func | object, scroller?: func | object, startScrollButtonIcon?: func | object } | {} | 用于内部每个 slot 的 props。 |
slots | { endScrollButtonIcon?: elementType, EndScrollButtonIcon?: elementType, indicator?: elementType, list?: elementType, root?: elementType, scrollbar?: elementType, scrollButtons?: elementType, scroller?: elementType, startScrollButtonIcon?: elementType, StartScrollButtonIcon?: elementType } | {} | 用于内部每个 slot 的组件。 |
sx | Array<func | object | bool> | func | object | - | 允许定义系统覆盖以及其他 CSS 样式的系统 prop。 有关更多详细信息,请参阅 `sx` 页面。 |
TabIndicatorProps | object | {} | 应用于选项卡指示器元素的 Props。 |
TabScrollButtonProps | object | {} | 应用于 |
textColor | 'inherit' | 'primary' | 'secondary' | 'primary' | 确定 |
value | any | - | 当前选定的 |
variant | 'fullWidth' | 'scrollable' | 'standard' | 'standard' | 确定选项卡的附加显示行为
|
visibleScrollbar | bool | false | 如果为 |
ref
被转发到根元素。主题默认 props
您可以使用 MuiTabs
通过主题更改此组件的默认 props。
Slot 名称 | 类名 | 默认组件 | 描述 |
---|---|---|---|
root | .MuiTabs-root | div | 用于 popper 的组件。 |
scroller | .MuiTabs-scroller | div | 用于 scroller 的组件。 |
list | .MuiTabs-list | div | 用于 flex 容器的组件。 |
scrollbar | ScrollbarSize | 用于 scroller 的组件。 | |
indicator | .MuiTabs-indicator | span | 用于选项卡指示器的组件。 |
scrollButtons | .MuiTabs-scrollButtons | TabScrollButton | 用于滚动按钮的组件。 |
startScrollButtonIcon | KeyboardArrowLeft | 用于开始滚动按钮图标的组件。 | |
endScrollButtonIcon | KeyboardArrowRight | 用于结束滚动按钮图标的组件。 |
这些类名对于使用 CSS 设置样式很有用。当触发特定状态时,它们会应用于组件的 slot。
类名 | 规则名称 | 描述 |
---|---|---|
.MuiTabs-centered | centered | 如果 centered={true} & !variant="scrollable" ,则应用于 flex 容器元素的样式。 |
.MuiTabs-fixed | fixed | 如果 !variant="scrollable" ,则应用于 tablist 元素的样式。 |
.MuiTabs-flexContainer | flexContainer | |
.MuiTabs-flexContainerVertical | flexContainerVertical | |
.MuiTabs-hideScrollbar | hideScrollbar | 如果 variant="scrollable" 且 visibleScrollbar={false} ,则应用于 tablist 元素的样式。 |
.MuiTabs-scrollableX | scrollableX | 如果 variant="scrollable" 且 orientation="horizontal" ,则应用于 tablist 元素的样式。 |
.MuiTabs-scrollableY | scrollableY | 如果 variant="scrollable" 且 orientation="vertical" ,则应用于 tablist 元素的样式。 |
.MuiTabs-scrollButtonsHideMobile | scrollButtonsHideMobile | 如果 allowScrollButtonsMobile={true} ,则应用于 ScrollButtonComponent 组件的样式。 |
.MuiTabs-vertical | vertical | 如果 orientation="vertical" ,则应用于根元素的样式。 |
您可以使用以下定制选项之一覆盖组件的样式
- 使用全局类名。
- 在自定义主题中使用规则名称作为组件的
styleOverrides
属性的一部分。
源代码
如果您在此页面中找不到所需的信息,请考虑查看 组件的实现 以获取更多详细信息。