表格API
React Table 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。
演示
导入
import Table from '@mui/joy/Table';
// or
import { Table } from '@mui/joy';通过阅读有关最小化 bundle size 的指南,了解它们之间的区别。
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| borderAxis | 'both' | 'bothBetween' | 'none' | 'x' | 'xBetween' | 'y' | 'yBetween' | string | 'xBetween' | 在表格单元格上显示边框的轴。 |
| children | node | - | 表格的子元素 |
| color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'neutral' | 组件的颜色。它支持对该组件有意义的主题颜色。 要了解如何添加自己的颜色,请查看主题组件—扩展颜色。 |
| component | elementType | - | 用于根节点的组件。可以是用于 HTML 元素的字符串或组件。 |
| hoverRow | bool | false | 如果 |
| noWrap | bool | false | 如果 |
| size | 'sm' | 'md' | 'lg' | string | 'md' | 组件的大小。它接受 'sm' 和 'lg' 之间的主题值。 要了解如何向组件添加自定义尺寸,请查看主题组件—扩展尺寸。 |
| slotProps | { root?: func | object } | {} | 用于内部每个插槽的 props。 |
| slots | { root?: elementType } | {} | 用于内部每个插槽的组件。 有关更多详细信息,请参见下面的插槽 API。 |
| stickyFooter | bool | false | 如果 |
| stickyHeader | bool | false | 如果 |
| stripe | 'odd' | 'even' | string | - | 表格主体的奇数行或偶数行将具有微妙的背景颜色。 |
| sx | Array<func | object | bool> | func | object | - | 允许定义系统覆盖以及其他 CSS 样式的系统 prop。 有关更多详细信息,请参见`sx` 页面。 |
| variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'plain' | 要使用的全局 variant。 要了解如何添加自己的 variant,请查看主题组件—扩展 variants。 |
ref 被转发到根元素。主题默认 props
您可以使用 JoyTable 通过主题更改此组件的默认 props。
要了解如何自定义插槽,请查看覆盖组件结构指南。
| 插槽名称 | 类名 | 默认组件 | 描述 |
|---|---|---|---|
| root | .MuiTable-root | 'table' | 渲染根组件的组件。 |
这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时,它们会应用于组件的插槽。
| 类名 | 规则名称 | 描述 |
|---|---|---|
| .MuiTable-borderAxisBoth | borderAxisBoth | 如果 borderAxis="both",则应用于根元素的类名。 |
| .MuiTable-borderAxisBothBetween | borderAxisBothBetween | 如果 borderAxis="bothBetween",则应用于根元素的类名。 |
| .MuiTable-borderAxisNone | borderAxisNone | 如果 borderAxis="none",则应用于根元素的类名。 |
| .MuiTable-borderAxisX | borderAxisX | 如果 borderAxis="x",则应用于根元素的类名。 |
| .MuiTable-borderAxisXBetween | borderAxisXBetween | 如果 borderAxis="xBetween",则应用于根元素的类名。 |
| .MuiTable-borderAxisY | borderAxisY | 如果 borderAxis="y",则应用于根元素的类名。 |
| .MuiTable-borderAxisYBetween | borderAxisYBetween | 如果 borderAxis="yBetween",则应用于根元素的类名。 |
| .MuiTable-colorContext | colorContext | 当颜色反转被触发时,应用于根元素的类名。 |
| .MuiTable-colorDanger | colorDanger | 如果 color="danger",则应用于根元素的类名。 |
| .MuiTable-colorNeutral | colorNeutral | 如果 color="neutral",则应用于根元素的类名。 |
| .MuiTable-colorPrimary | colorPrimary | 如果 color="primary",则应用于根元素的类名。 |
| .MuiTable-colorSuccess | colorSuccess | 如果 color="success",则应用于根元素的类名。 |
| .MuiTable-colorWarning | colorWarning | 如果 color="warning",则应用于根元素的类名。 |
| .MuiTable-hoverRow | hoverRow | 如果 hoverRow 为 true,则应用于根元素的类名。 |
| .MuiTable-noWrap | noWrap | 如果 noWrap 为 true,则应用于根元素的类名。 |
| .MuiTable-sizeLg | sizeLg | 如果 size="lg",则应用于根元素的类名。 |
| .MuiTable-sizeMd | sizeMd | 如果 size="md",则应用于根元素的类名。 |
| .MuiTable-sizeSm | sizeSm | 如果 size="sm",则应用于根元素的类名。 |
| .MuiTable-stickyFooter | stickyFooter | 如果 stickyFooter 为 true,则应用于根元素的类名。 |
| .MuiTable-stickyHeader | stickyHeader | 如果 stickyHeader 为 true,则应用于根元素的类名。 |
| .MuiTable-variantOutlined | variantOutlined | 如果 variant="outlined",则应用于根元素的类名。 |
| .MuiTable-variantPlain | variantPlain | 如果 variant="plain",则应用于根元素的类名。 |
| .MuiTable-variantSoft | variantSoft | 如果 variant="soft",则应用于根元素的类名。 |
| .MuiTable-variantSolid | variantSolid | 如果 variant="solid",则应用于根元素的类名。 |
您可以使用以下自定义选项之一来覆盖组件的样式
- 使用全局类名。
- 在自定义主题中使用组件的
styleOverrides属性中的规则名称。
源代码
如果您在此页面中没有找到所需的信息,请考虑查看组件的实现以获取更多详细信息。