Typography

Basic text writing, including headings, body text, lists, and more.
Importimport{ Typography }from"antd";

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。基于『确定』和『自然』的设计价值观,通过模块化的解决方案,降低冗余的生产成本,让设计者专注于更好的用户体验

设计资源

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

Display the document sample.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

h1. Ant Design

h2. Ant Design

h3. Ant Design

h4. Ant Design

h5. Ant Design

Display title in different levels.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
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)

Provides multiple types of text and a link.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
This is an editable text.
This is a loooooooooooooooooooooooooooooooong editable text with suffix.
Custom Edit icon and replace tooltip text.
Trigger edit with:
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

Makes Typography editable.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
This is a copyable text.
Replace copy text.
Custom Copy icon and replace tooltips text.
Hide Copy tooltips.
Request copy text.

Makes Typography copyable with the click of a button.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
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.

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

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
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 multi line text omission.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
5.16.0
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.

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

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
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

Add suffix ellipsis support.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

API

Common props ref:Common props

Typography.Text

PropertyDescriptionTypeDefaultVersion
codeCode stylebooleanfalse
copyableWhether to be copyable, customize it via setting an objectboolean | copyablefalse
deleteDeleted line stylebooleanfalse
disabledDisabled contentbooleanfalse
editableIf editable. Can control edit state when is objectboolean | editablefalse
ellipsisDisplay 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 manuallyboolean | Omit<ellipsis, 'expandable' | 'rows' | 'onExpand'>false
keyboardKeyboard stylebooleanfalse4.3.0
markMarked stylebooleanfalse
onClickSet the handler to handle click event(event) => void-
strongBold stylebooleanfalse
italicItalic stylebooleanfalse4.16.0
typeContent typesecondary | success | warning | danger-success: 4.6.0
underlineUnderlined stylebooleanfalse

Typography.Title

PropertyDescriptionTypeDefaultVersion
codeCode stylebooleanfalse
copyableWhether to be copyable, customize it via setting an objectboolean | copyablefalse
deleteDeleted line stylebooleanfalse
disabledDisabled contentbooleanfalse
editableIf editable. Can control edit state when is objectboolean | editablefalse
ellipsisDisplay ellipsis when text overflows, can configure rows and expandable by using objectboolean | ellipsisfalse
levelSet content importance. Match with h1, h2, h3, h4, h5number: 1, 2, 3, 4, 515: 4.6.0
markMarked stylebooleanfalse
onClickSet the handler to handle click event(event) => void-
italicItalic stylebooleanfalse4.16.0
typeContent typesecondary | success | warning | danger-success: 4.6.0
underlineUnderlined stylebooleanfalse

Typography.Paragraph

PropertyDescriptionTypeDefaultVersion
codeCode stylebooleanfalse
copyableWhether to be copyable, customize it via setting an objectboolean | copyablefalse
deleteDeleted line stylebooleanfalse
disabledDisabled contentbooleanfalse
editableIf editable. Can control edit state when is objectboolean | editablefalse
ellipsisDisplay ellipsis when text overflows, can configure rows and expandable by using objectboolean | ellipsisfalse
markMarked stylebooleanfalse
onClickSet the handler to handle click event(event) => void-
strongBold stylebooleanfalse
italicItalic stylebooleanfalse4.16.0
typeContent typesecondary | success | warning | danger-success: 4.6.0
underlineUnderlined stylebooleanfalse

copyable

{
text: string | (() => string | Promise<string>),
onCopy: function(event),
icon: ReactNode,
tooltips: false | [ReactNode, ReactNode],
format: 'text/plain' | 'text/html',
tabIndex: number,
}
PropertyDescriptionTypeDefaultVersion
formatThe Mime Type of the text'text/plain' | 'text/html'-4.21.0
iconCustom copy icon: [copyIcon, copiedIcon][ReactNode, ReactNode]-4.6.0
textThe text to copystring-
tooltipsCustom tooltip text, hide when it is false[ReactNode, ReactNode][Copy, Copied]4.4.0
onCopyCalled when copied textfunction-
tabIndexSet tabIndex of the copy buttonnumber05.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,
}
PropertyDescriptionTypeDefaultVersion
autoSizeautoSize attribute of textareaboolean | { minRows: number, maxRows: number }-4.4.0
editingWhether to be editablebooleanfalse
iconCustom editable iconReactNode<EditOutlined />4.6.0
maxLengthmaxLength attribute of textareanumber-4.4.0
tooltipCustom tooltip text, hide when it is falseReactNodeEdit4.6.0
textEdit text, specify the editing content instead of using the children implicitlystring-4.24.0
onChangeCalled when input at textareafunction(value: string)-
onCancelCalled when type ESC to exit editable statefunction-
onStartCalled when enter editable statefunction-
onEndCalled when type ENTER to exit editable statefunction-4.14.0
triggerTypeEdit mode trigger - icon, text or both (not specifying icon as trigger hides it)Array<icon|text>[icon]
enterIconCustom "enter" icon in the edit field (passing null removes the icon)ReactNode<EnterOutlined />4.17.0
tabIndexSet tabIndex of the edit buttonnumber05.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;
}
PropertyDescriptionTypeDefaultVersion
expandableWhether to be expandableboolean | 'collapsible'-collapsible: 5.16.0
rowsMax rows of contentnumber-
suffixSuffix of ellipsis contentstring-
symbolCustom description of ellipsisReactNode | ((expanded: boolean) => ReactNode)Expand Collapse
tooltipShow tooltip when ellipsisReactNode | TooltipProps-4.11.0
defaultExpandedDefault expand or collapseboolean5.16.0
expandedExpand or Collapseboolean5.16.0
onEllipsisCalled when enter or leave ellipsis statefunction(ellipsis)-4.2.0
onExpandCalled when expand contentfunction(event, { expanded: boolean })-info: 5.16.0

Design Token

Component TokenHow to use?

Token NameDescriptionTypeDefault Value
titleMarginBottomMargin bottom of titlestring | number0.5em
titleMarginTopMargin top of titlestring | number1.2em

Global TokenHow to use?

FAQ

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