类型
Typtography 组件在设计系统中提供一致的文本样式,带有预先定义的变体和颜色方案.
安装
npm install @cleartrip/ct-design-typography
# or
pnpm add @cleartrip/ct-design-typography
同伴依赖关系
# Required for all targets
npm install react
# Web only
npm install react-dom
# React Native only
npm install react-native
使用量
基础
import { Typography, TypographyVariant, TypographyColor } from '@cleartrip/ct-design-typography';
function Example() {
return (
<Typography variant={TypographyVariant.B1} color={TypographyColor.PRIMARY}>
This is sample typography text
</Typography>
);
}
标题
<Typography variant={TypographyVariant.HD1} color={TypographyColor.HEADING}>
Large Display Heading
</Typography>
<Typography variant={TypographyVariant.HM1} color={TypographyColor.HEADING}>
Medium Heading
</Typography>
文本正文
<Typography variant={TypographyVariant.B1} color={TypographyColor.PRIMARY}>
Large body text for important content
</Typography>
<Typography variant={TypographyVariant.B2} color={TypographyColor.SECONDARY}>
Regular body text with secondary color
</Typography>
自定义样式
<Typography
variant={TypographyVariant.B1}
color={TypographyColor.PRIMARY}
styleConfig={{
text: [{ fontWeight: 'bold', textDecoration: 'underline' }],
}}
>
Custom styled text
</Typography>
道具
| Prop | 类型 | 默认 | 需求 | 说明 |
|---|---|---|---|---|
children | ReactNode | —— 说 | 对 | 打印元素中要显示的内容 . |
variant | TypographyVariantType | —— 说 | 对 | 排字的变体,如"h1","body1"等. |
color | TypographyColorType | —— 说 | 没有 | 所取印相之相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相. |
isUnderlined | boolean | —— 说 | 没有 | 如果选中的话, 在打印中添加下划线效果 . |
isStriked | boolean | —— 说 | 没有 | 若为真,则会给打字机添加切换效果. |
isClickable | boolean | —— 说 | 没有 | 如果选中的话, 请单击打印功能 . |
onClick | () => void | —— 说 | 没有 | 点击打字时触发的回调函数 . |
colorCode | string | —— 说 | 没有 | 要覆盖默认颜色的颜色代码 . |
showInItalics | boolean | —— 说 | 没有 | 如果选中的话, 请使用斜体打印 . |
width | string | —— 说 | 没有 | 打印元素的宽度 . |
lineClamp | number | —— 说 | 没有 | 夹取文字行数. 增加椭圆(.)作为溢出部分. |
isDisabled | boolean | —— 说 | 没有 | 如果为真,则禁用用户交互的打字功能. |
componentNode | TypographyNodeElementType | —— 说 | 没有 | 用于渲染打字的 HTML 元素类型 . |
styleConfig | TypographyStyleConfigProps | —— 说 | 没有 | 打印的样式配置 . |
备选案文
显示( HD)
HD1– 额外的大显示文本HD2— 大显示文本HD3— 中型显示文本
标题(HM)
HM1- 大标题HM2中标题HM3——小标题HM4- 额外小标题
车体(B)
B1- 大正文文本B2——正文文本B3——小正文文本B3CAPS—小盖子文本B4— 额外的小正文文本B4CAPS— 额外的小盖文字
(P)段
P1- 大段P2- 中段P3- 小段
标签( L)
L1- 大标签L2中标签L3- 小标签
特别
OVERLINE— 超行文本TAG标记文本M4BOLD粗体变体
颜色
PRIMARY— 主文本颜色SECONDARY—— 次文本颜色TERTIARY— 第三级文本颜色HEADING——标题颜色SUBHEADING——子标题颜色SUCCESS成功状态颜色ALERT——警报/错误状态颜色WARNING— 警告状态颜色DISABLED— 已禁用状态颜色LINK链接颜色NEUTRAL中性颜色BRAND——品牌颜色
移徙
如果从以前的版本迁移:
- import { Typography } from 'yagami/core/components';
+ import { Typography, TypographyVariant, TypographyColor } from '@cleartrip/ct-design-typography';