面包屑API
React 面包屑组件的 API 参考文档。了解此导出模块的属性、CSS 和其他 API。
示例
导入
import Breadcrumbs from '@mui/joy/Breadcrumbs';
// or
import { Breadcrumbs } from '@mui/joy';原生组件的属性也可用。
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| children | node | - | 组件的内容。 |
| component | elementType | - | 用于根节点的组件。可以是用于 HTML 元素的字符串或组件。 |
| separator | node | '/' | 自定义分隔符节点。 |
| size | 'sm' | 'md' | 'lg' | string | 'md' | 组件的大小。它接受 'sm' 和 'lg' 之间的主题值。 要了解如何向组件添加自定义尺寸，请查看主题组件 - 扩展尺寸。 |
| slotProps | { li?: func | object, ol?: func | object, root?: func | object, separator?: func | object } | {} | 用于内部每个插槽的属性。 |
| slots | { li?: elementType, ol?: elementType, root?: elementType, separator?: elementType } | {} | 用于内部每个插槽的组件。 有关更多详细信息，请参阅下面的插槽 API。 |
| sx | Array<func | object | bool> | func | object | - | 允许定义系统覆盖以及其他 CSS 样式的系统属性。 有关更多详细信息，请参阅 `sx` 页面。 |
ref 被转发到根元素。主题默认属性
您可以使用 JoyBreadcrumbs 通过主题更改此组件的默认属性。
要了解如何自定义插槽，请查看覆盖组件结构指南。
| 插槽名称 | 类名 | 默认组件 | 描述 |
|---|---|---|---|
| root | .MuiBreadcrumbs-root | 'nav' | 渲染根的组件。 |
| ol | .MuiBreadcrumbs-ol | 'ol' | 渲染 ol 的组件。 |
| li | .MuiBreadcrumbs-li | 'li' | 渲染 li 的组件。 |
| separator | .MuiBreadcrumbs-separator | 'li' | 渲染分隔符的组件。 |
这些类名对于使用 CSS 进行样式设置很有用。当特定状态被触发时，它们会应用于组件的插槽。
| 类名 | 规则名称 | 描述 |
|---|---|---|
| .MuiBreadcrumbs-sizeLg | sizeLg | 如果 size="lg"，则应用于根元素的类名。 |
| .MuiBreadcrumbs-sizeMd | sizeMd | 如果 size="md"，则应用于根元素的类名。 |
| .MuiBreadcrumbs-sizeSm | sizeSm | 如果 size="sm"，则应用于根元素的类名。 |
您可以使用以下自定义选项之一来覆盖组件的样式
- 使用全局类名。
- 在自定义主题中，将规则名称作为组件的
styleOverrides属性 的一部分。
源代码
如果您在此页面中找不到所需信息，请考虑查看组件的实现以获取更多详细信息。