跳到主要内容跳到主要内容

TabListAPI

React TabList 组件的 API 参考文档。了解此导出的模块的 props、CSS 和其他 API。

演示

导入

import TabList from '@mui/joy/TabList';
// or
import { TabList } from '@mui/joy';

通过阅读此关于最小化 bundle size 的指南,了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称类型默认值描述
childrennode-

如果未设置 src,则用于在 TabList 内部渲染图标或文本元素。这可以是一个元素,或者只是一个字符串。

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'neutral'

组件的颜色。它支持对该组件有意义的主题颜色。

要了解如何添加自己的颜色,请查看主题组件—扩展颜色

componentelementType-

用于根节点的组件。可以是用于 HTML 元素的字符串或组件。

disableUnderlineboolfalse

如果为 true,TabList 的下划线将消失。

size'sm'
| 'md'
| 'lg'
| string
-

组件的尺寸。

要了解如何向组件添加自定义尺寸,请查看主题组件—扩展尺寸

slotProps{ root?: func
| object }
{}

用于内部每个插槽的 props。

slots{ root?: elementType }{}

用于内部每个插槽的组件。

有关更多详细信息,请参见下面的插槽 API

sticky'bottom'
| 'top'
-

如果提供,TabList 将具有 sticky 定位。

sxArray<func
| object
| bool>
| func
| object
-

允许定义系统 overrides 以及其他 CSS 样式的系统 prop。

有关更多详细信息,请参见 `sx` 页面

tabFlexnumber
| string
-

Tab 的 flex 值。

underlinePlacement'bottom'
| 'left'
| 'right'
| 'top'
orientation === 'horizontal' ? 'bottom' : 'right'

TabList 下划线的位置。

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
'plain'

要使用的全局 variant

要了解如何添加自己的 variants,请查看主题组件—扩展 variants

ref 被转发到根元素。

主题默认 props

您可以使用 JoyTabList 通过主题更改此组件的默认 props。

插槽

要了解如何自定义插槽,请查看覆盖组件结构指南。

插槽名称类名默认组件描述
root.MuiTabList-root'div'渲染根组件的组件。

CSS 类

这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时,它们将应用于组件的插槽。

类名规则名称描述
.MuiTabList-colorContextcolorContext当颜色反转被触发时,应用于根元素的类名。
.MuiTabList-colorDangercolorDanger如果 color="danger",则应用于根元素的类名。
.MuiTabList-colorNeutralcolorNeutral如果 color="neutral",则应用于根元素的类名。
.MuiTabList-colorPrimarycolorPrimary如果 color="primary",则应用于根元素的类名。
.MuiTabList-colorSuccesscolorSuccess如果 color="success",则应用于根元素的类名。
.MuiTabList-colorWarningcolorWarning如果 color="warning",则应用于根元素的类名。
.MuiTabList-sizeLgsizeLg如果 size="lg",则应用于根元素的类名。
.MuiTabList-sizeMdsizeMd如果 size="md",则应用于根元素的类名。
.MuiTabList-sizeSmsizeSm如果 size="sm",则应用于根元素的类名。
.MuiTabList-variantOutlinedvariantOutlined如果 variant="outlined",则应用于根元素的类名。
.MuiTabList-variantPlainvariantPlain如果 variant="plain",则应用于根元素的类名。
.MuiTabList-variantSoftvariantSoft如果 variant="soft",则应用于根元素的类名。
.MuiTabList-variantSolidvariantSolid如果 variant="solid",则应用于根元素的类名。

您可以使用以下自定义选项之一来覆盖组件的样式

源代码

如果您在此页面中没有找到所需的信息,请考虑查看组件的实现以获取更多详细信息。