semi-design/content/basic/typography/index-en-US.md

---

localeCode: en-US order: 21 category: Basic title: Typography subTitle: Typography icon: doc-typography

brief: The basic format of text, images, paragraphs, and numeric.

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 '@douyinfe/semi-ui';

Title

Use heading to set different levels of headint title.

import React from 'react';
import { Typography } from '@douyinfe/semi-ui';

function Demo() {
    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 build-in styles for icon. Different from passing icon to children, using icon for link will have no underline in compliance with Semi Design principles.

import React from 'react';
import { Typography } from '@douyinfe/semi-ui';

function Demo() {
    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="success">{'Success v>=1.7.0'}</Text>
            <br />
            <br />
            <Text type="danger">Danger</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>.

import React from 'react';
import { Typography } from '@douyinfe/semi-ui';
import { IconLink } from '@douyinfe/semi-icons';

function Demo() {
    const { Text } = Typography;
    return (
        <div>
            <Text link={{ href: 'https://semi.design/' }}>Link</Text>
            <br />
            <br />
            <Text link={{ href: 'https://semi.design/' }}>Open Website</Text>
            <br />
            <br />
            <Text link icon={<IconLink />} underline>Link</Text>
        </div>
    );
}

Paragraph

Paragraph component has two spacings. You could setspacing='extended' for a looser spacing.

import React from 'react';
import { Typography } from '@douyinfe/semi-ui';

function Demo() {
    const { Paragraph, Title } = Typography;
    return (
        <div>
            <Title heading={5}>Default Spacing</Title>
            <Paragraph>
                {`Life's but a walking shadow, a poor player, that struts and frets his hour upon the stage, and then is heard no more; it is a tale told by an idiot, full of sound and fury, signifying nothing.`}
            </Paragraph>
            <br />
            <Title heading={5}>Extended Spacing</Title>
            <Paragraph spacing="extended">
                {`Life's but a walking shadow, a poor player, that struts and frets his hour upon the stage, and then is heard no more; it is a tale told by an idiot, full of sound and fury, signifying nothing.`}
            </Paragraph>
        </div>
    );
}

Numeral

Based on Text component, added properties: rule, precision, truncate, parser, to provide the ability to handle Numeral in text separately.

The Numeral component recursively traverses Children to detect all numeric text within it for conversion and display, taking care to control the rendering structure hierarchy.<br />
For Numeral components with a rule of percentage, the data processing rules have changed. In <strong>v2.22.0-v2.29.0</strong>, for num whose absolute value is greater than or equal to 1, the result is num%; for num whose absolute value is less than or equal to 1, the result is (num*100)%. After the <strong>v2.30.0</strong> version, it is unified to (num*100)%.

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 percentages to automatically convert numbers to percentages
• set to bytes-decimal to automatically convert numbers to bytes, 1 KB is defined as 1000 bytes, (B, KB, MB, GB, TB, PB, EB, ZB, YB)
• Set to bytes-binary automatically 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 the precision and truncate attributes
• 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

  import React from 'react';
  import { Typography } from '@douyinfe/semi-ui';
  
  function Demo() {
  const { Numeral } = Typography;
  return (
      <div>
          <Numeral precision={1}>
              <p>Liked：1.6111e1 K</p>
          </Numeral>
  
          <p>
              Views:
              <Numeral rule="numbers" precision={1}>
                  2.4444e2
              </Numeral>
              K
          </p>
              
          <Numeral rule="percentages" precision={2} style={{ marginBottom: 12 }}>
              <p>Favorable rating: 0.915</p>
          </Numeral>
  
          <Numeral rule="percentages" style={{ marginBottom: 12 }}>
              My odds of winning this game are 0.6 and my odds of losing are 0.4.
          </Numeral>
  
          <Numeral rule="bytes-decimal" precision={2} truncate="floor">
              <p>Used: 1000</p>
              <p>Available: {1024*1000}</p> 
          </Numeral>
              
          <Numeral rule="bytes-binary" precision={2} truncate="floor">
              <p>Used: 1024</p>
              <p>Available: {2e12}</p>
          </Numeral>
      </div>
  );
  }
  

Parsing rules can be customised via parser.

import React from 'react';
import { Typography } from '@douyinfe/semi-ui';

function Demo() {
    const { Numeral } = Typography;

    function parserTCH(oldVal) {
        return oldVal.split(' ').map(item =>
            Number(item) ? `${item.replace(/(\d)(?=(?:\d{3})+(?:\.|$))/g, '$1,')}+` : item
        ).join(' ');
    }

    function Infos() {
        const data = [
            { type: 'Stars', min: '7100' },
            { type: 'Fork', min: '560' },
            { type: 'Downloads', min: '5000000' },
            { type: 'Contributors', min: '100' }
        ];
        return data.map(item =>
            <p key={item.min}>
                {item.type}：
                <b style={{ color: 'rgba(var(--semi-violet-5),1)' }}>
                    {item.min}
                </b>
            </p>
        );
    }

    return (
        <div>
            <Numeral parser={parserTCH} component="div">
                Semi Design value our users, any kind of contribution is welcome
                {Infos}
            </Numeral>
            <br />
            <Numeral link={{ href: 'https://semi.design', target: '_blank' }} parser={parserTCH}>
                Trusted by {1e5} users, Go to website &gt;&gt;
            </Numeral>
        </div>
    );
}

Size

Paragraph and Text component support two sizes, small(12px) and normal(14px). 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.

import React from 'react';
import { Typography } from '@douyinfe/semi-ui';

function Demo() {
    const { Paragraph, Text } = Typography;
    return (
        <div>
            <Text>Normal</Text>
            <Paragraph spacing="extended">
                {`Life's but a walking shadow, a poor player, that struts and frets his hour upon the stage, and then is heard no more; it is a tale told by an idiot, full of sound and fury, signifying nothing.`}
            </Paragraph>
            <br />
            <Text size='small'>Small</Text>
            <Paragraph size='small'>
                {`Life's but a walking shadow, a poor player, that struts and frets his hour upon the stage, and then is heard no more; it is a tale told by an idiot, full of sound and fury, signifying nothing.`}
            </Paragraph>
            <br />
            <Text size="small">This is a Text, size is small
                <Text link size="inherit">This is a Text，size is inherit, inherit parent's size</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.

import React from 'react';
import { Typography, TextArea } from '@douyinfe/semi-ui';
import { IconSetting } from '@douyinfe/semi-icons';

function Demo() {
    const { Paragraph, Text, Numeral } = Typography;

    return (
        <div>
            <Paragraph copyable>Click the right icon to copy text.</Paragraph>
            <Paragraph copyable={{ content: 'Hello, Semi Design!' }}>Click to copy text.</Paragraph>
            <Paragraph copyable={{ onCopy: () => Toast.success({ content: 'Successfully copied.' }) }}>Click the right icon to copy.</Paragraph>
            Timestamp: <Numeral truncate="ceil" copyable underline>{new Date().getTime()/1000}s</Numeral>
            <Paragraph copyable={{ icon: <IconSetting style={{ color: 'var(--semi-color-link)' }}/> }}>Custom Copy Node</Paragraph>
            <br/>
            <br/>
            <Text type="secondary">Paste here: </Text>
            <br/>
            <TextArea autosize style={{ width: 320, marginTop: 4 }} rows={3} />
        </div>
    );
}

Ellipsis

Show ellipsis if text is overflowed. Refer to Ellipsis Config for detailed configuration.

1. ellipsis only supports truncation of plain text, and does not support complex types such as reactNode. Please ensure that the content type of children is string <br/><br/>
2. To achieve abbreviation, ellipsis needs to have a clear width or maxWidth limit for comparison and judgment. If the width is not set by itself (for example, purely relying on the flex property to expand), or the width is an indefinite value such as 100%, the parent needs to have a clear width or maxWidth<br/><br/>
3. Ellipsis needs to obtain information such as the width and height of the DOM to make basic judgments. If there is a display:none style in itself or the parent, the value will be incorrect, and the abbreviation will be invalid at this time<br/><br/>
4. For more information on ellipsis see <a href="#faq">FAQ</a> 

import React from 'react';
import { Typography, Tooltip } from '@douyinfe/semi-ui';

function Demo() {
    const { Paragraph, Text, Title } = Typography;
    const customRenderTooltip = useCallback((content, children) => {
        return <Tooltip content={content} style={{ backgroundColor: 'var(--semi-color-primary)' }}>{children}</Tooltip>;
    }, []);

    return (
        <div>
            <Title heading={5} ellipsis={{ showTooltip: true }} style={{ width: 250 }}>
                This is a supercalifragilisticexpialidocious title
            </Title>
            <br />
            <Text 
                ellipsis={{ 
                    showTooltip: {
                        opts: { content: 'This is a supercalifragilisticexpialidocious tooltip' }
                    }
                }}
                style={{ width: 150 }}
            >
                Custom tooltip text if you need
            </Text>
            <br />
            <Text link ellipsis={{ showTooltip: true, pos: 'middle' }} style={{ width: 150 }}>
                This is a supercalifragilisticexpialidocious link
            </Text>
            <br/>
            <Paragraph ellipsis={{ suffix: '-Macbeth' }} style={{ width: 300 }}>
                {`With suffix: Life's but a walking shadow, a poor player, that struts and frets his hour upon the stage, and then is heard no more; it is a tale told by an idiot, full of sound and fury, signifying nothing.`}
            </Paragraph>
            <br/>
            <Paragraph ellipsis={{ rows: 3 }} style={{ width: 300 }}>
                {`Multi-line ellipsis: Life's but a walking shadow, a poor player, that struts and frets his hour upon the stage, and then is heard no more; it is a tale told by an idiot, full of sound and fury, signifying nothing.`}
            </Paragraph>
            <br/>
            <Paragraph ellipsis={{ rows: 3, showTooltip: { type: 'popover', opts: { style: { width: 300 } } } }} style={{ width: 300 }}>
                {`With Popover: Life's but a walking shadow, a poor player, that struts and frets his hour upon the stage, and then is heard no more; it is a tale told by an idiot, full of sound and fury, signifying nothing.`}
            </Paragraph>
            <br/>
            <Paragraph ellipsis={{ rows: 3, expandable: true, collapsible: true, collapseText: 'Show Less', onExpand: (bool, e) => console.log(bool, e) }} style={{ width: 300 }}>
                {`Expandable and collapsible: Life's but a walking shadow, a poor player, that struts and frets his hour upon the stage, and then is heard no more; it is a tale told by an idiot, full of sound and fury, signifying nothing.`}
            </Paragraph>
            <br />
            <Title 
                heading={6} 
                ellipsis={{ 
                    showTooltip: {
                        renderTooltip: customRenderTooltip
                    }
                }} 
                style={{ width: 250 }}
                
            >
                Custom tooltip with a blue background color
            </Title>
        </div>
    );
}

<div>When the tooltip does not wrap in the pop-up tooltip when the long text occurs, please set it manually through <a href="https://developer.mozilla.org/zh-CN/docs/Web/CSS/word-break" target="_blank"  rel="noopener noreferrer">word-break</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-wrap" target= "_blank" rel="noopener noreferrer">word-wrap</a>, more details can be found in the FAQ section of Tooltip</div>

import React from 'react';
import { Typography } from '@douyinfe/semi-ui';

function Demo() {
    const { Text } = Typography;

    return (
        <div>
            <Text 
                ellipsis={{ 
                    showTooltip: {
                        opts: { content: 'Insfrastructure|Data-inf|bytegraph.cheetah.user_relation' }
                    }
                }}
                style={{ width: 150 }}
            >
                Customized configuration can be made on demand when long text is truncated
            </Text>
            <br />
            <Text 
                ellipsis={{ 
                    showTooltip: {
                        opts: { content: 'Insfrastructure|Data-inf|bytegraph.cheetah.user_relation', className: 'components-typography-demo' }
                    }
                }}
                style={{ width: 150 }}
            >
                Customized configuration can be made on demand when long text is truncated
            </Text>
            <br />
            <Text 
                ellipsis={{
                    showTooltip: {
                        opts: { content: 'Insfrastructure|Data-inf|bytegraph.cheetah.user_relation', style: { wordBreak: 'break-all' } }
                    }
                }}
                style={{ width: 150 }}
            >
                Customized configuration can be made on demand when long text is truncated
            </Text>
        </div>
    );
}

// config word-break

.components-typography-demo {
    word-break: break-word;
    // or
    word-break: break-all;
}

API Reference

Typography.Text

Properties	Instructions	type	Default	version
copyable	Toggle whether to be copyable	boolean | object:Copyable Config	false	0.27.0
code	wrap with code element	boolean	-
component	Custom rendering html element	html element	span
delete	Deleted style	boolean	false	0.27.0
disabled	Disabled style	boolean	false	0.27.0
ellipsis	Display ellipsis when text overflows	boolean|object:Ellipsis Config	false	0.34.0
icon	Prefix icon.	ReactNode	-	0.27.0
link	Toggle whether to display as a link. When passing object, the attributes will be transparently passed to the a tag	boolean|object	false	0.27.0
mark	Marked style	boolean	false	0.27.0
size	Size, one of normal, small, inherit	string	normal	0.27.0
strong	Bold style	boolean	false	0.27.0
type	Type, one of primary, secondary, warning, danger, tertiary(v>=1.2.0) , quaternary(v>=1.2.0), success(v>=1.7.0)	string	primary	0.27.0
underline	Underlined style	boolean	false	0.27.0
weight	set font weight	number		2.34.0

Typography.Title

Properties	Instructions	type	Default	version
copyable	Toggle whether to be copyable	boolean | object:Copyable Config	false	0.27.0
component	Custom rendering html element. The default is determined by heading prop	html element	h1~h6
delete	Deleted style	boolean	false	0.27.0
disabled	Disabled style	boolean	false	0.27.0
ellipsis	Display ellipsis when text overflows	boolean|object:Ellipsis Config	false	0.34.0
heading	Heading level, one of 1， 2， 3，4，5，6	number	1	0.27.0
link	Toggle whether to display as a link. When passing object, the attributes will be transparently passed to the a tag	boolean|object	false	0.27.0
mark	Marked style	boolean	false	0.27.0
type	Type, one of primary, secondary, warning, danger, tertiary(v>=1.2.0), quaternary(v>=1.2.0), success(v>=1.7.0)	string	primary	0.27.0
underline	Underlined style	boolean	false	0.27.0
weight	set font weight, one of light, regular, medium, semibold, bold, default	string, number		2.34.0

Typography.Paragraph

Properties	Instructions	type	Default	version
copyable	Toggle whether to be copyable	boolean | object:Copyable Config	false	0.27.0
component	Custom rendering html element	html element	p
delete	Deleted style	boolean	false	0.27.0
disabled	Disabled style	boolean	false	0.27.0
ellipsis	Display ellipsis when text overflows	boolean|object:Ellipsis Config	false	0.34.0
link	Toggle whether to display as a link. When passing object, the attributes will be transparently passed to the a tag	boolean|object	false	0.27.0
mark	Marked style	boolean	false	0.27.0
size	Size, one of normal，small	string	normal	0.27.0
spacing	paragraph spacing, one of normal, extended	string	normal	0.27.0
strong	Bold style	boolean	false	0.27.0
type	Type, one of primary, secondary, warning, danger, tertiary(v>=1.2.0), quaternary(v>=1.2.0), success(v>=1.7.0)	string	primary	0.27.0
underline	Underlined style	boolean	false	0.27.0

Typography.Numeral

Properties	Instructions	type	Default	version
rule	Parsing rules, one of text, numbers, bytes-decimal, bytes-binary, percentages, currency, exponential	string	text	2.22.0
precision	allows you to set the number of decimal places to be retained, used to set precision	number	0	2.22.0
truncate	The truncation of the number of decimal places, optionally ceil, floor, round, aligned with Math.ceil, Math.floor, Math.round	string	round	2.22.0
parser	Custom numeral parsing functions	(str: string) => string	-	2.22.0
copyable	Toggle whether to be copyable	boolean | object:Copyable Config	false	2.22.0
code	wrap with code element	boolean	-	2.22.0
component	Custom rendering html element	html element	span	2.22.0
delete	Deleted style	boolean	false	2.22.0
disabled	Disabled style	boolean	false	2.22.0
ellipsis	Display ellipsis when text overflows	boolean | object:Ellipsis Config	false	2.22.0
icon	Prefix icon.	ReactNode	-	2.22.0
link	Toggle whether to display as a link. When passing object, the attributes will be transparently passed to the a tag	boolean | object	false	2.22.0
mark	Marked style	boolean	false	2.22.0
size	Size, one of normal，small	string	normal	2.22.0
strong	Bold style	boolean	false	2.22.0
type	Type, one of primary, secondary, warning, danger, tertiary(v>=1.2.0) , quaternary(v>=1.2.0), success(v>=1.7.0)	string	primary	2.22.0
underline	Underlined style	boolean	false	2.22.0

Ellipsis Config

v >= 0.34.0

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	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	Version
content	Copied content	string	-	0.27.0
copyTip	Tooltip content when hovering over icon	React.node	-	1.0.0
icon	Custom Render Duplicate Node	React.node	-	2.31.0
onCopy	Callback for copy action	Function(e:Event, content:string, res:boolean)	-	0.27.0
successTip	Successful tip content	React.node	-	0.33.0

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

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、 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.