mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-25 19:50:05 +08:00
Code Issues Actions 20 Packages Projects Releases Wiki Activity
693d5a1434
ant-design/components/typography/index.en-US.md
Aaron Cawte 693d5a1434 General components doc tweaks (#19416) 
* Documentation - Button Component

* Documentation - Icon Component

* Documentation  - Typography component
2019-10-25 09:56:30 +08:00

3.4 KiB
Raw Blame History

category type title cols
Components General Typography 1

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

When To Use

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

API

Typography.Text

Property Description Type Default Version
code Code style boolean false 3.15.1
copyable Config copy. Can set copy text and callback when is an object boolean | { text: string, onCopy: Function } false 3.14.0
delete Deleted line style boolean false 3.14.0
disabled Disabled content boolean false 3.14.0
editable Editable. Can control edit state when is object boolean | { editing: boolean, onStart: Function, onChange: Function(string) } false 3.14.0
ellipsis Display ellipsis when text overflows boolean false 3.14.0
mark Marked style boolean false 3.14.0
underline Underlined style boolean false 3.14.0
onChange Trigger when user edits the content Function(string) - 3.14.0
strong Bold style boolean false 3.14.0
type Content type secondary, warning, danger - 3.14.0

Typography.Title

Property Description Type Default Version
code Code style boolean false 3.15.1
copyable Config copy. Can set copy text and callback when is an object boolean | { text: string, onCopy: Function } false 3.14.0
delete Deleted line style boolean false 3.14.0
disabled Disabled content boolean false 3.14.0
editable Editable. Can control edit state when is object boolean | { editing: boolean, onStart: Function, onChange: Function(string) } false 3.14.0
ellipsis Display ellipsis when text overflows. Can configure rows and expandable by using object boolean | { rows: number, expandable: boolean, onExpand: Function } false 3.14.0
level Set content importance. Match with h1, h2, h3, h4 number: 1, 2, 3, 4 1 3.14.0
mark Marked style boolean false 3.14.0
underline Underlined style boolean false 3.14.0
onChange Trigger when user edits the content Function(string) - 3.14.0
type Content type secondary, warning, danger - 3.14.0

Typography.Paragraph

Property Description Type Default Version
code Code style boolean false 3.15.1
copyable Config copy. Can set copy text and callback when is an object boolean | { text: string, onCopy: Function } false 3.14.0
delete Deleted line style boolean false 3.14.0
disabled Disabled content boolean false 3.14.0
editable Editable. Can control edit state when is object boolean | { editing: boolean, onStart: Function, onChange: Function(string) } false 3.14.0
ellipsis Display ellipsis when text overflows. Can configure rows and expandable by using object boolean | { rows: number, expandable: boolean, onExpand: Function } false 3.14.0
mark Marked style boolean false 3.14.0
underline Underlined style boolean false 3.14.0
onChange Trigger when user edits the content Function(string) - 3.14.0
strong Bold style boolean false 3.14.0
type Content type secondary, warning, danger - 3.14.0