ant-design/components/typography/index.en-US.md
zombieJ c80136a9a7
New Component: Typography (#14250)
* text with prefix

* add edit style

* support editable

* enhance accessibility & type experience

* optimize IME case

* support copy

* add locale

* add secondary & disabled

* add ellipsis shadow text

* split to 3 components

* update snapshot

* update desc

* change lines also need update ellipsis

* skip aria when is in ellipsis

* add ResizeObserver in _util

* update snapshot

* move TestBase into test file

* update test case

* update doc

* fix typo

* important => level

* use rows

* update demo cols to 1

* fix cssText not work in firefox

* update doc

* add miss point

* support extendable

* update snapshot

* fix doc

* copyable support string

* update snapshot

* update doc

* update doc desc

* adjust style

* full test

* reset after test

* rename

* update snapshot

* fix compile

* adjust style

* update desc

* update prefixCls

* update margin

* adjust

* nest wrap of tag content

* adjust style

* update comment

* rm %

* one more thing

* tmp of measure

* merge string as children

* update snapshot

* update testcase

* remove comment

* use internal variable for configProvider passing

* update snapshot

* use expandable instead of extendable

* less variable it

* update demo

* update less

* adjust code & mark style

* remove mark padding

* update measure logic

* support nest element style

* use childNode.textContent to fix react 15 error

* update css

* popout Typography

* add link style

* adjust doc

* use ellipsis instead of rows & expandable

* update doc

* update doc

* update doc & style

* fix typo

* add css ellipsis support

* client render

* update snapshot

* enhance copyable

* support onExpand

* update test case

* add test of css ellipsis

* fix logic in react 15

* rename onChange -> onSave

* use tagName of article

* fix lint
2019-02-19 11:42:05 +08:00

64 lines
3.0 KiB
Markdown

---
category: Components
type: General
title: Typography
cols: 1
---
Basic format and regular operation on text.
## When To Use
When need to display title or text content. Like:
* Copy
* Ellipsis / expand
* Edit
* Markdown Typography
## API
### Typography.Text
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | false |boolean \| string | false |
| delete | delete line style | boolean | false |
| disabled | Disable content | boolean | false |
| editable | Editable. Can control edit state when is object | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false |
| ellipsis | Display ellipsis when overflow | boolean | false |
| mark | mark style | boolean | false |
| underline | underline style | boolean | false |
| onChange | Trigger when user edit the content | Function(string) | - |
| strong | bold style | boolean | false |
| type | Content type | `secondary`, `warning`, `danger` | - |
### Typography.Title
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | false |boolean \| string | false |
| delete | delete line style | boolean | false |
| disabled | Disable content | boolean | false |
| editable | Editable. Can control edit state when is object | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false |
| ellipsis | Display ellipsis when overflow. Can config rows and expandable by using object | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false |
| level | Set content importance. Match with `h1`, `h2`, `h3`, `h4` | number: `1`, `2`, `3`, `4` | 1 |
| mark | mark style | boolean | false |
| underline | underline style | boolean | false |
| onChange | Trigger when user edit the content | Function(string) | - |
| type | Content type | `secondary`, `warning`, `danger` | - |
### Typography.Paragraph
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | false |boolean \| string | false |
| delete | delete line style | boolean | false |
| disabled | Disable content | boolean | false |
| editable | Editable. Can control edit state when is object | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false |
| ellipsis | Display ellipsis when overflow. Can config rows and expandable by using object | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false |
| mark | mark style | boolean | false |
| underline | underline style | boolean | false |
| onChange | Trigger when user edit the content | Function(string) | - |
| strong | bold style | boolean | false |
| type | Content type | `secondary`, `warning`, `danger` | - |