Typography

Basic text writing, including headings, body text, lists, and more.

Importimport{ Typography }from"antd";

Sourcecomponents/typography

Docs

Edit this page Changelog

When To Use

When you need to display a title or paragraph contents in Articles/Blogs/Notes.
When you need copyable/editable/ellipsis texts.

Examples

Introduction

In the process of internal desktop applications development, many different design specs and implementations would be involved, which might cause designers and developers difficulties and duplication and reduce the efficiency of development.

After massive project practice and summaries, Ant Design, a design language for background applications, is refined by Ant UED Team, which aims to uniform the user interface specs for internal background projects, lower the unnecessary cost of design differences and implementation and liberate the resources of design and front-end development.

Guidelines and Resources

We supply a series of design principles, practical patterns and high quality design resources (Sketch and Axure), to help people create their product prototypes beautifully and efficiently.

Press Esc to exit...

介绍

蚂蚁的企业级产品是一个庞大且复杂的体系。这类产品不仅量级巨大且功能复杂，而且变动和并发频繁，常常需要设计与开发能够快速的做出响应。同时这类产品中有存在很多类似的页面以及组件，可以通过抽象得到一些稳定且高复用性的内容。

随着商业化的趋势，越来越多的企业级产品对更好的用户体验有了进一步的要求。带着这样的一个终极目标，我们（蚂蚁集团体验技术部）经过大量的项目实践和总结，逐步打磨出一个服务于企业级产品的设计体系 Ant Design。基于『确定』和『自然』的设计价值观，通过模块化的解决方案，降低冗余的生产成本，让设计者专注于更好的用户体验。

设计资源

我们提供完善的设计原则、最佳实践和设计资源文件（Sketch 和Axure），来帮助业务快速设计出高质量的产品原型。

AntV 是蚂蚁集团全新一代数据可视化解决方案，致力于提供一套简单方便、专业可靠、不限可能的数据可视化最佳实践。得益于丰富的业务场景和用户需求挑战，AntV 经历多年积累与不断打磨，已支撑整个阿里集团内外 20000+ 业务系统，通过了日均千万级 UV 产品的严苛考验。我们正在基础图表，图分析，图编辑，地理空间可视化，智能可视化等各个可视化的领域耕耘，欢迎同路人一起前行。

AntV 是蚂蚁集团全新一代数据可视化解决方案，致力于提供一套简单方便、专业可靠、不限可能的数据可视化最佳实践。得益于丰富的业务场景和用户需求挑战，AntV 经历多年积累与不断打磨，已支撑整个阿里集团内外 20000+ 业务系统，通过了日均千万级 UV 产品的严苛考验。
我们正在基础图表，图分析，图编辑，地理空间可视化，智能可视化等各个可视化的领域耕耘，欢迎同路人一起前行。

按Esc键退出阅读……

Basic

Display the document sample.

h1. Ant Design

h2. Ant Design

h3. Ant Design

h4. Ant Design

h5. Ant Design

Title Component

Display title in different levels.

Ant Design (default)

Ant Design (secondary)

Ant Design (success)

Ant Design (warning)

Ant Design (danger)

Ant Design (disabled)

Ant Design (mark)

Ant Design (code)

Ant Design (keyboard)

Ant Design (underline)

~~Ant Design (delete)~~

Ant Design (strong)

Ant Design (italic)

Ant Design (Link)

Text and Link Component

Provides multiple types of text and a link.

This is an editable text.

This is a loooooooooooooooooooooooooooooooong editable text with suffix.

Custom Edit icon and replace tooltip text.

Trigger edit with:

icontextboth

Text or icon as trigger - click to start editing.

Editable text with a custom enter icon in edit field.

Editable text with no enter icon in edit field.

Hide Edit tooltip.

This is an editable text with limited length.

h1. Ant Design

h2. Ant Design

h3. Ant Design

h4. Ant Design

h5. Ant Design

Editable

Makes Typography editable.

This is a copyable text.

Replace copy text.

Custom Copy icon and replace tooltips text.

Hide Copy tooltips.

Request copy text.

Copyable

Makes Typography copyable with the click of a button.

Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.

Ellipsis

Multiple line ellipsis support. You can use tooltip to configure ellipsis tooltip. The expandable property is recommended when you have lots of content.

Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.Ant Design, a design language for background applications, is refined by Ant UED Team.

Controlled ellipsis expand/collapse

Controlled multi line text omission.

5.16.0

Ellipsis from middle

You can ellipsis content from middle by customize ellipsis={{ suffix: ... }}.

To be, or not to be, that is the question: Whether it is nobler in the mind to suffer. The slings and arrows of outrageous fortune Or to take arms against a sea of troubles, And by opposing end them? To die: to sleep; No more; and by a sleep to say we end The heart-ache and the thousand natural shocks That flesh is heir to, 'tis a consummation Devoutly to be wish'd. To die, to sleep To sleep- perchance to dream: ay, there's the rub! For in that sleep of death what dreams may come When we have shuffled off this mortal coil, Must give us pause. There 's the respect That makes calamity of so long life--William Shakespeare

suffix

Add suffix ellipsis support.

API

Common props ref：Common props

Typography.Text

Property	Description	Type	Default	Version
code	Code style	boolean	false
copyable	Whether to be copyable, customize it via setting an object	boolean \| copyable	false
delete	Deleted line style	boolean	false
disabled	Disabled content	boolean	false
editable	If editable. Can control edit state when is object	boolean \| editable	false
ellipsis	Display ellipsis when text overflows, can't configure expandable、rows and onExpand by using object. Diff with Typography.Paragraph, Text do not have 100% width style which means it will fix width on the first ellipsis. If you want to have responsive ellipsis, please set width manually	boolean \| Omit<ellipsis, 'expandable' \| 'rows' \| 'onExpand'>	false
keyboard	Keyboard style	boolean	false	4.3.0
mark	Marked style	boolean	false
onClick	Set the handler to handle click event	(event) => void	-
strong	Bold style	boolean	false
italic	Italic style	boolean	false	4.16.0
type	Content type	`secondary` \| `success` \| `warning` \| `danger`	-	success: 4.6.0
underline	Underlined style	boolean	false

Typography.Title

Property	Description	Type	Default	Version
code	Code style	boolean	false
copyable	Whether to be copyable, customize it via setting an object	boolean \| copyable	false
delete	Deleted line style	boolean	false
disabled	Disabled content	boolean	false
editable	If editable. Can control edit state when is object	boolean \| editable	false
ellipsis	Display ellipsis when text overflows, can configure rows and expandable by using object	boolean \| ellipsis	false
level	Set content importance. Match with `h1`, `h2`, `h3`, `h4`, `h5`	number: 1, 2, 3, 4, 5	1	5: 4.6.0
mark	Marked style	boolean	false
onClick	Set the handler to handle click event	(event) => void	-
italic	Italic style	boolean	false	4.16.0
type	Content type	`secondary` \| `success` \| `warning` \| `danger`	-	success: 4.6.0
underline	Underlined style	boolean	false

Typography.Paragraph

Property	Description	Type	Default	Version
code	Code style	boolean	false
copyable	Whether to be copyable, customize it via setting an object	boolean \| copyable	false
delete	Deleted line style	boolean	false
disabled	Disabled content	boolean	false
editable	If editable. Can control edit state when is object	boolean \| editable	false
ellipsis	Display ellipsis when text overflows, can configure rows and expandable by using object	boolean \| ellipsis	false
mark	Marked style	boolean	false
onClick	Set the handler to handle click event	(event) => void	-
strong	Bold style	boolean	false
italic	Italic style	boolean	false	4.16.0
type	Content type	`secondary` \| `success` \| `warning` \| `danger`	-	success: 4.6.0
underline	Underlined style	boolean	false

copyable

{
  text: string | (() => string | Promise<string>),
  onCopy: function(event),
  icon: ReactNode,
  tooltips: false | [ReactNode, ReactNode],
  format: 'text/plain' | 'text/html',
  tabIndex: number,
}

Property	Description	Type	Default	Version
format	The Mime Type of the text	'text/plain' \| 'text/html'	-	4.21.0
icon	Custom copy icon: [copyIcon, copiedIcon]	[ReactNode, ReactNode]	-	4.6.0
text	The text to copy	string	-
tooltips	Custom tooltip text, hide when it is false	[ReactNode, ReactNode]	[`Copy`, `Copied`]	4.4.0
onCopy	Called when copied text	function	-
tabIndex	Set tabIndex of the copy button	number	0	5.17.0

editable

{
  icon: ReactNode,
  tooltip: ReactNode,
  editing: boolean,
  maxLength: number,
  autoSize: boolean | { minRows: number, maxRows: number },
  text: string,
  onChange: function(string),
  onCancel: function,
  onStart: function,
  onEnd: function,
  triggerType: ('icon' | 'text')[],
  enterIcon: ReactNode,
  tabIndex: number,
}

Property	Description	Type	Default	Version
autoSize	`autoSize` attribute of textarea	boolean \| { minRows: number, maxRows: number }	-	4.4.0
editing	Whether to be editable	boolean	false
icon	Custom editable icon	ReactNode	<EditOutlined />	4.6.0
maxLength	`maxLength` attribute of textarea	number	-	4.4.0
tooltip	Custom tooltip text, hide when it is false	ReactNode	`Edit`	4.6.0
text	Edit text, specify the editing content instead of using the children implicitly	string	-	4.24.0
onChange	Called when input at textarea	function(value: string)	-
onCancel	Called when type ESC to exit editable state	function	-
onStart	Called when enter editable state	function	-
onEnd	Called when type ENTER to exit editable state	function	-	4.14.0
triggerType	Edit mode trigger - icon, text or both (not specifying icon as trigger hides it)	Array<`icon`\|`text`>	[`icon`]
enterIcon	Custom "enter" icon in the edit field (passing `null` removes the icon)	ReactNode	`<EnterOutlined />`	4.17.0
tabIndex	Set tabIndex of the edit button	number	0	5.17.0

ellipsis

interface EllipsisConfig {
  rows: number;
  /** `collapsible` added in `5.16.0` */
  expandable: boolean | 'collapsible';
  suffix: string;
  /** render function added in `5.16.0` */
  symbol: ReactNode | ((expanded: boolean) => ReactNode);
  tooltip: ReactNode | TooltipProps;
  /** added in `5.16.0` */
  defaultExpanded: boolean;
  /** added in `5.16.0` */
  expanded: boolean;
  /** `info` added in `5.16.0` */
  onExpand: (event: MouseEvent, info: { expanded: boolean }) => void;
  onEllipsis: (ellipsis: boolean) => void;
}

Property	Description	Type	Default	Version
expandable	Whether to be expandable	boolean \| 'collapsible'	-	`collapsible`: 5.16.0
rows	Max rows of content	number	-
suffix	Suffix of ellipsis content	string	-
symbol	Custom description of ellipsis	ReactNode \| ((expanded: boolean) => ReactNode)	`Expand` `Collapse`
tooltip	Show tooltip when ellipsis	ReactNode \| TooltipProps	-	4.11.0
defaultExpanded	Default expand or collapse	boolean		5.16.0
expanded	Expand or Collapse	boolean		5.16.0
onEllipsis	Called when enter or leave ellipsis state	function(ellipsis)	-	4.2.0
onExpand	Called when expand content	function(event, { expanded: boolean })	-	`info`: 5.16.0

Design Token

Component TokenHow to use?

Token Name	Description	Type	Default Value
titleMarginBottom	Margin bottom of title	string \| number	0.5em
titleMarginTop	Margin top of title	string \| number	1.2em

Global TokenHow to use?

FAQ

How to use Typography.Link in react-router?

react-router support customize render component:

<Link to="/" component={Typography.Link} />

Note： This is not equivalent to the execution logic of react-router's Link reference