mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-25 11:40:04 +08:00
67 lines
3.1 KiB
Markdown
67 lines
3.1 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 |
|
|
| -------- | ----------- | ---- | ------- |
|
|
| code | code style | boolean | false |
|
|
| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | 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 |
|
|
| -------- | ----------- | ---- | ------- |
|
|
| code | code style | boolean | false |
|
|
| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | 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 |
|
|
| -------- | ----------- | ---- | ------- |
|
|
| code | code style | boolean | false |
|
|
| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | 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` | - |
|