When to Use
- To display the text content of articles, blogs, logs, etc.
- To take basic operations such as copying and omitting text.
Demos
How to import
import { Typography } from '@fibrous/semi-ui-react';
Title
Use heading to set different levels of headint title.
h1. Semi Design
h2. Semi Design
h3. Semi Design
h4. Semi Design
h5. Semi Design
h6. Semi Design
Code
import { Typography } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Title } = Typography;
return (
<div>
<Title style={{ margin: '8px 0' }}>h1. Semi Design</Title>
<Title heading={2} style={{ margin: '8px 0' }}>
h2. Semi Design
</Title>
<Title heading={3} style={{ margin: '8px 0' }}>
h3. Semi Design
</Title>
<Title heading={4} style={{ margin: '8px 0' }}>
h4. Semi Design
</Title>
<Title heading={5} style={{ margin: '8px 0' }}>
h5. Semi Design
</Title>
<Title heading={6} style={{ margin: '8px 0' }}>
h6. Semi Design
</Title>
</div>
);
}Text
Text component has different built-in styles.
You could also pass icon to use the built-in styles for icon. Different from passing icon to children, using icon for link will have no underline in compliance with Semi Design Next principles.
Secondary
Tertiary v>=1.2.0
Quaternary v>=1.2.0
Warning
Danger
Success v>=1.7.0
Disabled
Default Mark
Example CodeUnderline
Strong
Code
import { Typography } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Text } = Typography;
return (
<div>
<Text>Text</Text>
<br />
<br />
<Text type="secondary">Secondary</Text>
<br />
<br />
<Text type="tertiary">{`Tertiary v>=1.2.0`}</Text>
<br />
<br />
<Text type="quaternary">{`Quaternary v>=1.2.0`}</Text>
<br />
<br />
<Text type="warning">Warning</Text>
<br />
<br />
<Text type="danger">Danger</Text>
<br />
<br />
<Text type="success">{`Success v>=1.7.0`}</Text>
<br />
<br />
<Text disabled>Disabled</Text>
<br />
<br />
<Text mark>Default Mark</Text>
<br />
<br />
<Text code>Example Code</Text>
<br />
<br />
<Text underline>Underline</Text>
<br />
<br />
<Text delete>Deleted</Text>
<br />
<br />
<Text strong>Strong</Text>
</div>
);
}You could pass object to link, which will be mounted on <a>.
Code
import { IconLink } from '@fibrous/semi-icons-react';
import { Typography } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Text } = Typography;
return (
<div>
<Text link={{ href: 'https://semi.design/' }}>链接文本</Text>
<br />
<br />
<Text link={{ href: 'https://semi.design/' }}>打开网站</Text>
<br />
<br />
<Text link icon={<IconLink />} underline>
带下划线的网页链接
</Text>
</div>
);
}Paragraph
Paragraph component has two spacings. You could setspacing='extended' for a looser spacing.
默认行距
Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
宽松行距
Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
Code
import { Typography } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Paragraph, Title } = Typography;
return (
<div>
<Title heading={5}>默认行距</Title>
<Paragraph>Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。</Paragraph>
<br />
<Title heading={5}>宽松行距</Title>
<Paragraph spacing="extended">Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。</Paragraph>
</div>
);
}Numeral
Based on Text component, added properties: rule, precision, truncate, parser, to provide the ability to handle Numeral in text separately.
precision allows you to set the number of decimal places to be retained, used to set precision
truncate The truncation of the number of decimal places, optionally ceil, floor, round, aligned with Math.ceil, Math.floor, Math.round
rule for setting the parsing rules
- set to
percentagesto automatically convert numbers to percentages - set to
bytes-decimalto automatically convert numbers to bytes, 1 KB is defined as 1000 bytes, (B, KB, MB, GB, TB, PB, EB, ZB, YB) - Set to
bytes-binaryautomatically converts the number to the unit of display corresponding to bytes, 1 KiB is defined as equal to 1024 bytes, (B, KiB, MiB, GiB, TiB, PiB, EiB, ZiB, YiB) - When set to
text, Automatic rounding of numbers only, based on theprecisionandtruncateattributes - When set to
numbers, non-numeric characters will be filtered and only numbers will be displayed - When set to
exponential, numbers are automatically converted to scientific notation
Numeral renders a span by default. When the content has block elements such as p, use component="div" to render a block container.
点赞量:16.1 K
播放量:244.4K
好评率: 91.50%
已使用: 1.00 KB
未使用: 1.02 MB
已使用: 1.00 KiB
未使用: 1.81 TiB
Code
import { Typography } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Numeral } = Typography;
return (
<div>
<Numeral precision={1} component="div">
<p>点赞量:1.6111e1 K</p>
</Numeral>
<p>
播放量:
<Numeral rule="numbers" precision={1}>
2.4444e2
</Numeral>
K
</p>
<Numeral rule="percentages" precision={2} component="div" style={{ marginBottom: 12 }}>
<p>好评率: 0.915</p>
</Numeral>
<Numeral rule="percentages" style={{ marginBottom: 12 }}>
这场比赛我的胜率是0.6,输的概率是0.4
</Numeral>
<Numeral rule="bytes-decimal" precision={2} truncate="floor" component="div">
<p>已使用: 1000</p>
<p>未使用: {1024 * 1000}</p>
</Numeral>
<Numeral rule="bytes-binary" precision={2} truncate="floor" component="div">
<p>已使用: 1024</p>
<p>未使用: {2e12}</p>
</Numeral>
</div>
);
}Parsing rules can be customised via parser.
Stars:7,100+
Fork:560+
Downloads:5,000,000+
Contributors:100+
现已服务 100,000+ 用户,前往官网 >>
Code
import { Typography } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Numeral } = Typography;
function parserTCH(oldVal: string) {
return oldVal
.split(' ')
.map((item) => (Number(item) ? `${item.replace(/(\d)(?=(?:\d{3})+(?:\.|$))/g, '$1,')}+` : item))
.join(' ');
}
const infos = [
{ type: 'Stars', min: '7100' },
{ type: 'Fork', min: '560' },
{ type: 'Downloads', min: '5000000' },
{ type: 'Contributors', min: '100' },
].map((item) => (
<p key={item.min}>
{item.type}:<b style={{ color: 'var(--semi-violet-5)' }}>{item.min}</b>
</p>
));
return (
<div>
<Numeral parser={parserTCH} component="div">
Semi Design 重视我们的用户,加入并助力我们不断完善
{infos}
</Numeral>
<br />
<Numeral link={{ href: 'https://semi.design', target: '_blank' }} parser={parserTCH}>
现已服务 {1e5} 用户,前往官网 >>
</Numeral>
</div>
);
}Size
Paragraph and Text component support two sizes, small(12px) and normal(14px), and inherit to take the outer size. By default it is set to normal.
When the paragraph component or text component are used nested, set the size property of the inner component to inherit, and the size of the inner component will inherit the size setting of the outer component.
Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
小文本
Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
这是一段文本,样式为 small这是一段链接,设置 size 为 inherit 继承外部样式设置
Code
import { Typography } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Paragraph, Text } = Typography;
return (
<div>
<Text>正常文本</Text>
<Paragraph spacing="extended">Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。</Paragraph>
<br />
<Text size="small">小文本</Text>
<Paragraph size="small">Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。</Paragraph>
<br />
<Text size="small">
这是一段文本,样式为 small
<Text link size="inherit">
这是一段链接,设置 size 为 inherit 继承外部样式设置
</Text>
</Text>
</div>
);
}Copyable text
Copying of text can be supported by configuring the copyable property.
When copyable is configured as true, the default copied content is children itself. Note that at this time, children only support string type.
When copyable is configured as object, you can specify the content copied to the clipboard through copyable.content, which is no longer strongly associated with children.
At this time, children will no longer limit the type, but copyable.content still needs to be a string.
You can use the copyable.render attribute to customize the copyable button render.
点击右边的图标复制文本。
点击复制文本。
点击右边的图标复制文本。
时间戳: 1563849139s自定义复制节点
自定义复制渲染
粘贴区域:
Code
import { IconSetting } from '@fibrous/semi-icons-react';
import { Typography, TextArea, Button, Toast } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Paragraph, Text, Numeral } = Typography;
const timestamp = 1563849138.25;
return (
<div>
<Paragraph copyable>点击右边的图标复制文本。</Paragraph>
<Paragraph copyable={{ content: 'Hello, Semi Design!' }}>点击复制文本。</Paragraph>
<Paragraph copyable={{ onCopy: () => Toast.success({ content: '复制文本成功' }) }}>点击右边的图标复制文本。</Paragraph>
时间戳:{' '}
<Numeral truncate="ceil" copyable underline>
{timestamp}s
</Numeral>
<Paragraph copyable={{ icon: <IconSetting style={{ color: 'var(--semi-color-link)' }} /> }}>自定义复制节点</Paragraph>
<Paragraph
copyable={{
content: 'Custom render!',
render: (copied, doCopy, config) => {
return (
<Button size="small" onClick={doCopy}>
<span>{copied ? '复制成功' : `点击复制:${config.content}`}</span>
</Button>
);
},
}}
>
自定义复制渲染
</Paragraph>
<br />
<br />
<Text id="typography-copyable-paste" type="secondary">
粘贴区域:
</Text>
<br />
<TextArea aria-labelledby="typography-copyable-paste" autosize style={{ width: 320, marginTop: 4 }} rows={3} />
</div>
);
}Ellipsis
Show ellipsis if text is overflowed. Refer to Ellipsis Config for detailed configuration.
是一个很长很长很长很长5号标题
可以自定义浮层里的展示内容试试看吧
是一个很长很长很长很长的链接
有后缀的情况:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。小尾巴
这是一个多行截断的例子:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
多行截断,展示 Popover:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
支持展开和折叠:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
sssssssssssssssssssssssss
这是一个自定义弹出层组件的省略文本,背景色是蓝色
Code
import { useCallback, type ReactNode } from 'react';
import { Typography, Tooltip, type TooltipProps } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Paragraph, Title, Text } = Typography;
const customRenderTooltip = useCallback((content: TooltipProps['content'], children: ReactNode) => {
return (
<Tooltip content={content} style={{ backgroundColor: 'var(--semi-color-primary)' }}>
{children}
</Tooltip>
);
}, []);
return (
<div>
<Title heading={5} ellipsis={{ showTooltip: true }} style={{ width: 250 }}>
是一个很长很长很长很长5号标题
</Title>
<br />
<Text
ellipsis={{
showTooltip: {
opts: { content: '这是自定义要展示的内容' },
},
}}
style={{ width: 150 }}
>
可以自定义浮层里的展示内容试试看吧
</Text>
<br />
{/* link 也可以传对象,例如 link={{ href: 'https://semi.design/zh-CN/basic/typography', target: '_blank' }} */}
<Text link ellipsis={{ showTooltip: true, pos: 'middle' }} style={{ width: 150 }}>
是一个很长很长很长很长的链接
</Text>
<br />
<Paragraph ellipsis={{ suffix: '小尾巴' }} style={{ width: 300 }}>
有后缀的情况:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。
</Paragraph>
<br />
<Paragraph ellipsis={{ rows: 3 }} style={{ width: 300 }}>
这是一个多行截断的例子:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
</Paragraph>
<br />
<Paragraph ellipsis={{ rows: 3, showTooltip: { type: 'popover', opts: { style: { width: 300 } } } }} style={{ width: 300 }}>
多行截断,展示 Popover:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
</Paragraph>
<br />
<Paragraph
ellipsis={{
rows: 3,
expandable: true,
collapsible: true,
collapseText: '折叠我吧',
onExpand: (bool, e) => console.log(bool, e),
}}
style={{ width: 300 }}
>
支持展开和折叠:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
</Paragraph>
<br />
<Text
ellipsis={{
showTooltip: {
opts: { content: '全英文设置了word-break' },
},
pos: 'middle',
}}
style={{ width: 150, wordBreak: 'break-word' }}
>
sssssssssssssssssssssssss
</Text>
<br />
<br />
<Title
heading={5}
ellipsis={{
showTooltip: {
renderTooltip: customRenderTooltip,
},
}}
style={{ width: 250 }}
>
这是一个自定义弹出层组件的省略文本,背景色是蓝色
</Title>
</div>
);
}覆盖类名超长文本发生截断时可使用类名覆盖进行自定义配置
覆盖style超长文本发生截断时可使用style进行自定义配置
Code
import { Typography } from '@fibrous/semi-ui-react';
export default function TypographyDemo() {
const { Text } = Typography;
return (
<div>
<Text
ellipsis={{
showTooltip: {
opts: { content: '架构|Semi-inf|graph.cheet.relation' },
},
}}
style={{ width: 150 }}
>
有问题的超长文本发生截断时可按需进行自定义配置
</Text>
<br />
<Text
ellipsis={{
showTooltip: {
opts: {
content: '架构|Semi-inf|graph.cheet.relation',
className: 'components-typography-demo',
},
},
}}
style={{ width: 150 }}
>
覆盖类名超长文本发生截断时可使用类名覆盖进行自定义配置
</Text>
<br />
<Text
ellipsis={{
showTooltip: {
opts: { content: '架构|Semi-inf|graph.cheet.relation', style: { wordBreak: 'break-all' } },
},
}}
style={{ width: 150 }}
>
覆盖style超长文本发生截断时可使用style进行自定义配置
</Text>
</div>
);
}// config word-break
.components-typography-demo {
word-break: break-word;
// or
word-break: break-all;
}
API Reference
Typography.Text
Props
| Property | Description | Type | Default |
|---|---|---|---|
| children | Text content. With copyable set to true, this is what gets copied; ellipsis only truncates pure text. | React.ReactNode | - |
| code | Whether the text is wrapped in a code element. | boolean | - |
| component | Tag name or component the root element renders as. Defaults to span. | React.ElementType | - |
| copyable | Whether the text can be copied; pass an object to configure it, see Copyable Config. | CopyableConfig | boolean | - |
| delete | Adds a strikethrough. | boolean | - |
| disabled | Disables the text. A link renders as a span that keeps only its style. | boolean | - |
| ellipsis | Truncates overflowing text; pass an object to configure it, see Ellipsis Config. | Ellipsis | boolean | - |
| icon | Prefix icon, a node. A Semi icon is sized to match the text. | React.ReactNode | string | - |
| link | Whether the text is a link. With an object, its attributes (href, target, className, style, onClick and so on) are applied to the inner a element. When disabled, only className and style are kept. | LinkType | - |
| mark | Adds a highlight. | boolean | - |
| ref | Reference to the root element. | TypeReact.Ref<HTMLSpanElement> | - |
| size | Text size: normal, small or inherit. inherit takes the size of the enclosing Typography component. Defaults to normal. | TypographyBaseSize | - |
| strong | Whether the text is bold. | boolean | - |
| type | Text type: primary, secondary, danger, warning, success, tertiary or quaternary. Defaults to primary. | TypographyBaseType | - |
| underline | Adds an underline. Link text shows it only on hover and active. | boolean | - |
| weight | Font weight as a number. | number | - |
className, style and other native attributes (such as id, aria-* and onClick) land on the root element. With a link object, its attributes land on the inner a element.
Typography.Title
Props
| Property | Description | Type | Default |
|---|---|---|---|
| component | Tag name or component the root element renders as. Defaults to the h1 to h6 matching heading. | React.ElementType | - |
| copyable | Whether the text can be copied; pass an object to configure it, see Copyable Config. | CopyableConfig | boolean | - |
| delete | Adds a strikethrough. | boolean | - |
| disabled | Disables the text. A link renders as a span that keeps only its style. | boolean | - |
| ellipsis | Truncates overflowing text; pass an object to configure it, see Ellipsis Config. | Ellipsis | boolean | - |
| heading | Heading level, matching h1 to h6. | 1 | 2 | 3 | 4 | 5 | 6 | 1 |
| link | Whether the text is a link. With an object, its attributes (href, target, className, style, onClick and so on) are applied to the inner a element. When disabled, only className and style are kept. | LinkType | - |
| mark | Adds a highlight. | boolean | - |
| ref | Reference to the root element. | TypeReact.Ref<HTMLHeadingElement> | - |
| strong | Whether the text is bold. | boolean | - |
| type | Text type: primary, secondary, danger, warning, success, tertiary or quaternary. Defaults to primary. | TypographyBaseType | - |
| underline | Adds an underline. Link text shows it only on hover and active. | boolean | - |
| weight | Font weight: light, regular, medium, semibold, bold, default, or a number. | Type'light' | 'regular' | 'medium' | 'semibold' | 'bold' | 'default' | number | - |
className, style and other native attributes (such as id, aria-* and onClick) land on the root element. With a link object, its attributes land on the inner a element.
Typography.Paragraph
Props
| Property | Description | Type | Default |
|---|---|---|---|
| component | Tag name or component the root element renders as. Defaults to p. | React.ElementType | - |
| copyable | Whether the text can be copied; pass an object to configure it, see Copyable Config. | CopyableConfig | boolean | - |
| delete | Adds a strikethrough. | boolean | - |
| disabled | Disables the text. A link renders as a span that keeps only its style. | boolean | - |
| ellipsis | Truncates overflowing text; pass an object to configure it, see Ellipsis Config. | Ellipsis | boolean | - |
| link | Whether the text is a link. With an object, its attributes (href, target, className, style, onClick and so on) are applied to the inner a element. When disabled, only className and style are kept. | LinkType | - |
| mark | Adds a highlight. | boolean | - |
| ref | Reference to the root element. | TypeReact.Ref<HTMLParagraphElement> | - |
| size | Text size: normal, small or inherit. inherit takes the size of the enclosing Typography component. Defaults to normal. | TypographyBaseSize | - |
| spacing | Line spacing; extended is looser. Defaults to normal. | TypographyBaseSpacing | - |
| strong | Whether the text is bold. | boolean | - |
| type | Text type: primary, secondary, danger, warning, success, tertiary or quaternary. Defaults to primary. | TypographyBaseType | - |
| underline | Adds an underline. Link text shows it only on hover and active. | boolean | - |
className, style and other native attributes (such as id, aria-* and onClick) land on the root element. With a link object, its attributes land on the inner a element.
Typography.Numeral
Props
| Property | Description | Type | Default |
|---|---|---|---|
| children | Content to format. Numbers are formatted in text at any depth, including inside child elements. | React.ReactNode | - |
| code | Whether the text is wrapped in a code element. | boolean | - |
| component | Tag name or component the root element renders as. Defaults to span; use div when the content has block elements such as p. | React.ElementType | - |
| copyable | Whether the text can be copied; pass an object to configure it, see Copyable Config. | CopyableConfig | boolean | - |
| delete | Adds a strikethrough. | boolean | - |
| disabled | Disables the text. A link renders as a span that keeps only its style. | boolean | - |
| icon | Prefix icon, a node. A Semi icon is sized to match the text. | React.ReactNode | string | - |
| link | Whether the text is a link. With an object, its attributes (href, target, className, style, onClick and so on) are applied to the inner a element. When disabled, only className and style are kept. | LinkType | - |
| mark | Adds a highlight. | boolean | - |
| parser | Custom number parser that takes the text and returns the string to show; rule no longer applies once it is set. | Type(value: string) => string | - |
| precision | Number of decimal places to keep. | number | 0 |
| ref | Reference to the root element. | TypeReact.Ref<HTMLSpanElement> | - |
| rule | Parsing rule: text only rounds, numbers filters out non-numeric characters, bytes-decimal and bytes-binary convert byte units (1 KB is 1000 bytes, 1 KiB is 1024 bytes), percentages converts to percent, exponential converts to scientific notation. | TypographyBaseRule | "text" |
| size | Text size: normal, small or inherit. inherit takes the size of the enclosing Typography component. Defaults to normal. | TypographyBaseSize | - |
| strong | Whether the text is bold. | boolean | - |
| truncate | How the kept decimals are rounded, matching Math.ceil, Math.floor and Math.round. | TypographyBaseTruncate | "round" |
| type | Text type: primary, secondary, danger, warning, success, tertiary or quaternary. Defaults to primary. | TypographyBaseType | - |
| underline | Adds an underline. Link text shows it only on hover and active. | boolean | - |
className, style and other native attributes (such as id, aria-* and onClick) land on the root element. With a link object, its attributes land on the inner a element.
Ellipsis Config
| Properties | Instructions | type | Default |
|---|---|---|---|
| collapseText | Displayed text to collapse | string | Collapse |
| collapsible | Toggle whether text is collapsible | boolean | false |
| expandText | Displayed text to expand | string | Expand |
| expandable | Toggle whether text is expandable | boolean | false |
| pos | Position to start ellipsis, one of end, middle | string | end |
| rows | Number of rows that should not be truncated | number | 1 |
| showTooltip | Toggle whether to show tooltip, if passed in as object: type,type of component to show tooltip, one of Tooltip, Popover; opts, properties that will be passed directly to the component; renderTooltip, custom rendering popup layer component. While the Tooltip can show, the text is a tab stop; inside an item of a composite widget (option, treeitem, menuitem, gridcell, row) it stays out of the tab order. showTooltip has no effect when expandable is true or expandText is set; the two are mutually exclusive | boolean|{type: 'tooltip'|'popover', opts: object, renderTooltip: ((content: ReactNode, children: ReactNode)) => ReactNode} | false |
| suffix | Text suffix that will not be truncated | string | - |
| onExpand | Callback when expand or collapse | function(expanded: bool, Event: e) | - |
Copyable Config
| Properties | Instructions | Type | Default |
|---|---|---|---|
| content | Copied content | string | - |
| className | Class name of the copy action's wrapping span | string | - |
| copyTip | Tooltip content when hovering over icon | React.node | - |
| duration | Seconds the copied state lasts | number | 3 |
| icon | Content of the copy button, any node rendered as given; the button is named by the icon element's aria-label, or the locale's "Copy" without one | React.node | - |
| onCopy | Callback for copy action, called asynchronously once the clipboard write (navigator.clipboard.writeText) settles; res is true when the write succeeds and false when it is rejected, in which case the copied state is not shown | Function(e:Event, content:string, res:boolean) | - |
| render | Custom render copy node | function(copied, doCopy, configs)(copied: boolean, doCopy: (e: React.MouseEvent) => void, configs: CopyableConfig) => React.ReactNode | - |
| style | Style of the copy action's wrapping span | CSSProperties | - |
| successTip | Successful tip content | React.node | - |
Content Guidelines
- Link
- Text links need to be clear and predictable, users should be able to predict what will happen when they click on the link
- Do not mislead users by mislabeling links
- Avoid using "Click here" or "Here" as stand-alone links
| ✅ Recommended usage | ❌ Deprecated usage |
|---|---|
| No spaces yet? Create space | No spaces yet? Click here |
- Avoid using entire sentences as clickable text links, and instead use text that describes where to go as the link content
| ✅ Recommended usage | ❌ Deprecated usage |
|---|---|
| Views user documentation for details | View user documentation for details |
- Using short terms or words as link text is more conducive to internationalization, to avoid the problem of link text being split due to different grammar and word order in different languages
| ✅ Recommended usage | ❌ Deprecated usage |
|---|---|
| Manage notifications to | Manage notifications to |
- When ending with a text link, there is no need to follow punctuation, except for the question mark "?"
| ✅ Recommended usage | ❌ Deprecated usage |
|---|---|
| No spaces yet? Create space | No spaces yet? Click here |
| Forgot password ? | Forgot password |
- Link text does not contain the articles "the, a, an"
| ✅ Recommended usage | ❌ Deprecated usage |
|---|---|
| View user documentation for details | View the user documentation for details |
Design Tokens
| Sass variable | Value | Usage |
|---|---|---|
| $color-typography_default-text-default | var(--semi-color-text-0) | 默认文本颜色 |
| $color-typography_secondary-text-default | var(--semi-color-text-1) | 稍次要文本颜色 |
| $color-typography_tertiary-text-default | var(--semi-color-text-2) | 次要文本颜色 |
| $color-typography_quaternary-text-default | var(--semi-color-text-3) | 最次要文本颜色 |
| $color-typography_warning-text-default | var(--semi-color-warning) | 警告文本颜色 |
| $color-typography_danger-text-default | var(--semi-color-danger) | 错误文本颜色 |
| $color-typography_success-text-default | var(--semi-color-success) | 成功文本颜色 |
| $color-typography_disabled-text-default | var(--semi-color-disabled-text) | 禁用文本颜色 |
| $color-typography_mark-bg-default | var(--semi-color-primary-light-default) | 标记文本颜色 |
| $color-typography_mark-text-default | var(--semi-color-text-0) | 标记文本文字颜色 |
| $font-typography_code-fontFamily | ui-monospace, sfmono-regular, menlo, consolas, monospace | 代码文本字体 |
| $font-typography_code-fontSize | 1em | 代码文本字号 |
| $color-typography_code-bg-default | var(--semi-color-fill-1) | 代码文本背景颜色 |
| $color-typography_code-text-default | var(--semi-color-text-2) | 代码文本颜色 |
| $color-typography_link-text-default | var(--semi-color-link) | 链接文本颜色 - 默认 |
| $color-typography_link-text-visited | var(--semi-color-link-visited) | 链接文本颜色 - 已访问 |
| $color-typography_link-text-hover | var(--semi-color-link-hover) | 链接文本颜色 - 悬浮 |
| $color-typography_link-text-active | var(--semi-color-link-active) | 链接文本颜色 - 激活 |
| $color-typography_link-text-disabled | var(--semi-color-link) | 链接文本颜色 - 禁用 |
| $color-typography_copied-text-success | var(--semi-color-text-2) | 可复制文本颜色 |
| $color-typography_copied-icon-success | var(--semi-color-success) | 可复制文本复制成功图标颜色 |
| $color-typography_code-border-default | var(--semi-color-border) | 代码文本描边颜色 |
| $font-typography_title-fontWeight | $font-weight-bold | 标题文本字重 |
| $font-typography_link-fontWeight | $font-weight-bold | 链接文本字重 |
| $font-typography_strong-fontWeight | $font-weight-bold | 强调文本字重 |
| $font-typography_paragraph_extended-lineHeight | 24px | 宽松行距段落文本行高 |
| $font-typography_smallText-regular-fontWeight | $font-weight-regular | small text 字重 - 正常 |
| $font-typography_normalParagraph-regular-fontWeight | $font-weight-regular | normal paragraph 字重 - 正常 |
| $font-typography_smallParagraph-regular-fontWeight | $font-weight-regular | small paragraph 字重 - 正常 |
| $font-typography_title1-fontWeight | $font-typography_title-fontWeight | 一级标题文本字重 |
| $font-typography_title2-fontWeight | $font-typography_title-fontWeight | 二级标题文本字重 |
| $font-typography_title3-fontWeight | $font-typography_title-fontWeight | 三级标题文本字重 |
| $font-typography_title4-fontWeight | $font-typography_title-fontWeight | 四级标题文本字重 |
| $font-typography_title5-fontWeight | $font-typography_title-fontWeight | 五级标题文本字重 |
| $font-typography_title6-fontWeight | $font-typography_title-fontWeight | 六级标题文本字重 |
| $font-typography_title1-light-fontWeight | 200 | 一级标题文本字重 - 细 |
| $font-typography_title2-light-fontWeight | 200 | 二级标题文本字重 - 细 |
| $font-typography_title3-light-fontWeight | 200 | 三级标题文本字重 - 细 |
| $font-typography_title4-light-fontWeight | 200 | 四级标题文本字重 - 细 |
| $font-typography_title5-light-fontWeight | 200 | 五级标题文本字重 - 细 |
| $font-typography_title6-light-fontWeight | 200 | 六级标题文本字重 - 细 |
| $font-typography_title1-regular-fontWeight | 400 | 一级标题文本字重 - 正常 |
| $font-typography_title2-regular-fontWeight | 400 | 二级标题文本字重 - 正常 |
| $font-typography_title3-regular-fontWeight | 400 | 三级标题文本字重 - 正常 |
| $font-typography_title4-regular-fontWeight | 400 | 四级标题文本字重 - 正常 |
| $font-typography_title5-regular-fontWeight | 400 | 五级标题文本字重 - 正常 |
| $font-typography_title6-regular-fontWeight | 400 | 六级标题文本字重 - 正常 |
| $font-typography_title1-medium-fontWeight | 500 | 一级标题文本字重 - 中等 |
| $font-typography_title2-medium-fontWeight | 500 | 二级标题文本字重 - 中等 |
| $font-typography_title3-medium-fontWeight | 500 | 三级标题文本字重 - 中等 |
| $font-typography_title4-medium-fontWeight | 500 | 四级标题文本字重 - 中等 |
| $font-typography_title5-medium-fontWeight | 500 | 五级标题文本字重 - 中等 |
| $font-typography_title6-medium-fontWeight | 500 | 六级标题文本字重 - 中等 |
| $font-typography_title1-semibold-fontWeight | 600 | 一级标题文本字重 - 半粗 |
| $font-typography_title2-semibold-fontWeight | 600 | 二级标题文本字重 - 半粗 |
| $font-typography_title3-semibold-fontWeight | 600 | 三级标题文本字重 - 半粗 |
| $font-typography_title4-semibold-fontWeight | 600 | 三级标题文本字重 - 半粗 |
| $font-typography_title5-semibold-fontWeight | 600 | 三级标题文本字重 - 半粗 |
| $font-typography_title6-semibold-fontWeight | 600 | 三级标题文本字重 - 半粗 |
| $font-typography_title1-bold-fontWeight | 700 | 一级标题文本字重 - 粗 |
| $font-typography_title2-bold-fontWeight | 700 | 二级标题文本字重 - 粗 |
| $font-typography_title3-bold-fontWeight | 700 | 三级标题文本字重 - 粗 |
| $font-typography_title4-bold-fontWeight | 700 | 三级标题文本字重 - 粗 |
| $font-typography_title5-bold-fontWeight | 700 | 三级标题文本字重 - 粗 |
| $font-typography_title6-bold-fontWeight | 700 | 三级标题文本字重 - 粗 |
| $spacing-typography_iconPrefix-marginRight | 4px | 带前缀文本图标右侧外边距 |
| $spacing-typography_expandText-marginLeft | 8px | 支持展开文本展开按钮左侧外边距 |
| $spacing-typography_copyIcon-marginLeft | 4px | 可复制文本复制图标左侧外边距 |
| $spacing-typography_copyIcon-padding | 0 | 可复制文本复制图标内边距 |
| $spacing-typography_title_h1-margin | 0 | 一级标题外边距 |
| $spacing-typography_title_h2-margin | 0 | 二级标题外边距 |
| $spacing-typography_title_h3-margin | 0 | 三级标题外边距 |
| $spacing-typography_title_h4-margin | 0 | 四级标题外边距 |
| $spacing-typography_title_h5-margin | 0 | 五级标题外边距 |
| $spacing-typography_title_h6-margin | 0 | 六级标题外边距 |
| $spacing-typography_title_paragraph-margin | 0 | 段落外边距 |
| $width-typography_code-border | 1px | 代码文本描边宽度 |
| $width-typography_link-border | 1px | 链接文本下划线宽度 |
| $radius-typography_code | 2px | 代码文本圆角 |
FAQ
-
What are the specific mechanism and precautions of Typography ellipsis?
Semi ellipsis has two strategies, CSS ellipsis and JS ellipsis. When setting middle truncation (pos='middle')、 expandable、 expandText is set (not undefined)、 suffix is not empty string、copyable, the JS ellipsis strategy is enabled. Otherwise, enable the CSS ellipsis strategy.
In general CSS truncation performance is better than JS truncation. when the children and container size remain unchanged, CSS truncation only involves 1~2 calculations, while js truncation is based on dichotomy and may require multiple calculations.
Pay attention to performance consumption when using a large number of Typography with ellipsis. For example, in Table, you can reduce performance loss by setting a reasonable pageSize for paging.