TypographyAPI
React Typography 组件的 API 参考文档。了解此导出模块的属性、CSS 和其他 API。
演示
导入
import Typography from '@mui/joy/Typography';
// or
import { Typography } from '@mui/joy';
通过阅读这篇关于最小化 bundle 大小的指南,了解它们之间的区别。
原生组件的属性也可用。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
children | node | - | 组件的内容。 |
color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | - | 组件的颜色。它支持对此组件有意义的主题颜色。 要了解如何添加您自己的颜色,请查看主题组件—扩展颜色。 |
component | elementType | - | 用于根节点的组件。可以使用字符串来使用 HTML 元素或组件。 |
endDecorator | node | - | 放置在子元素之后的元素。 |
gutterBottom | bool | false | 如果为 |
level | 'h1' | 'h2' | 'h3' | 'h4' | 'title-lg' | 'title-md' | 'title-sm' | 'body-lg' | 'body-md' | 'body-sm' | 'body-xs' | 'inherit' | string | 'body-md' | 应用主题排版样式。 |
levelMapping | object | { h1: 'h1', h2: 'h2', h3: 'h3', h4: 'h4', 'title-lg': 'p', 'title-md': 'p', 'title-sm': 'p', 'body-lg': 'p', 'body-md': 'p', 'body-sm': 'p', 'body-xs': 'span', inherit: 'p', } | 组件将 variant 属性映射到一系列不同的 HTML 元素类型。例如,body1 映射到 |
noWrap | bool | false | 如果为 |
slotProps | { endDecorator?: func | object, root?: func | object, startDecorator?: func | object } | {} | 用于每个内部插槽的属性。 |
slots | { endDecorator?: elementType, root?: elementType, startDecorator?: elementType } | {} | 用于每个内部插槽的组件。 有关更多详细信息,请参阅下面的 Slots API。 |
startDecorator | node | - | 放置在子元素之前的元素。 |
sx | Array<func | object | bool> | func | object | - | 允许定义系统覆盖以及其他 CSS 样式的系统属性。 有关更多详细信息,请参阅 `sx` 页面。 |
textColor | any | - | 系统颜色。 |
variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | - | 要使用的全局 variant。 要了解如何添加您自己的 variant,请查看主题组件—扩展 variant。 |
system
属性。您可以直接在组件上将它们用作属性。ref 被转发到根元素。
主题默认属性
您可以使用 JoyTypography
通过主题更改此组件的默认属性。
要了解如何自定义插槽,请查看覆盖组件结构指南。
插槽名称 | 类名 | 默认组件 | 描述 |
---|---|---|---|
root | .MuiTypography-root | 'a' | 呈现根元素的组件。 |
startDecorator | .MuiTypography-startDecorator | 'span' | 呈现 start 装饰器的组件。 |
endDecorator | .MuiTypography-endDecorator | 'span' | 呈现 end 装饰器的组件。 |
这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时,它们会应用于组件的插槽。
类名 | 规则名称 | 描述 |
---|---|---|
.MuiTypography-body-lg | body-lg | 如果 level="body-lg" ,则应用于根元素的类名。 |
.MuiTypography-body-md | body-md | 如果 level="body-md" ,则应用于根元素的类名。 |
.MuiTypography-body-sm | body-sm | 如果 level="body-sm" ,则应用于根元素的类名。 |
.MuiTypography-body-xs | body-xs | 如果 level="body-xs" ,则应用于根元素的类名。 |
.MuiTypography-colorContext | colorContext | 当颜色反转被触发时应用于根元素的类名。 |
.MuiTypography-colorDanger | colorDanger | 如果 color="danger" ,则应用于根元素的类名。 |
.MuiTypography-colorNeutral | colorNeutral | 如果 color="neutral" ,则应用于根元素的类名。 |
.MuiTypography-colorPrimary | colorPrimary | 如果 color="primary" ,则应用于根元素的类名。 |
.MuiTypography-colorSuccess | colorSuccess | 如果 color="success" ,则应用于根元素的类名。 |
.MuiTypography-colorWarning | colorWarning | 如果 color="warning" ,则应用于根元素的类名。 |
.MuiTypography-gutterBottom | gutterBottom | 如果 gutterBottom={true} ,则应用于根元素的类名。 |
.MuiTypography-h1 | h1 | 如果 level="h1" ,则应用于根元素的类名。 |
.MuiTypography-h2 | h2 | 如果 level="h2" ,则应用于根元素的类名。 |
.MuiTypography-h3 | h3 | 如果 level="h3" ,则应用于根元素的类名。 |
.MuiTypography-h4 | h4 | 如果 level="h4" ,则应用于根元素的类名。 |
.MuiTypography-noWrap | noWrap | 如果 nowrap={true} ,则应用于根元素的类名。 |
.MuiTypography-title-lg | title-lg | 如果 level="title-lg" ,则应用于根元素的类名。 |
.MuiTypography-title-md | title-md | 如果 level="title-md" ,则应用于根元素的类名。 |
.MuiTypography-title-sm | title-sm | 如果 level="title-sm" ,则应用于根元素的类名。 |
.MuiTypography-variantOutlined | variantOutlined | 如果 variant="outlined" ,则应用于根元素的类名。 |
.MuiTypography-variantPlain | variantPlain | 如果 variant="plain" ,则应用于根元素的类名。 |
.MuiTypography-variantSoft | variantSoft | 如果 variant="soft" ,则应用于根元素的类名。 |
.MuiTypography-variantSolid | variantSolid | 如果 variant="solid" ,则应用于根元素的类名。 |
您可以使用以下自定义选项之一覆盖组件的样式
- 使用全局类名。
- 在自定义主题中,将规则名称作为组件的
styleOverrides
属性的一部分。
源代码
如果您在此页面中没有找到所需信息,请考虑查看组件的实现以获取更多详细信息。