mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-29 13:47:02 +08:00
0d1b1c40a6
* feat: add Table expandable fixed (#29959) * fix: Use flex gap of space (#30023) * fix: use flex gap when supported * test: update snapshot * refactor: Use single hooks * feat: Allow breadcrumb component in PageHeader (#30019) * Allow breadcrumb component in PageHeader * Allow breadcrumb component in PageHeader * Allow breadcrumb component in PageHeader * Rename variable rename var from _breadcrumbRender to breadcrumbRenderDomFromProps * feat: add onChange for Statistic.Countdown (#30265) * feat: add onChange for countdown * update the demo * feat(upload): add onDrop (#30319) * feat(upload): Add onDrop * Replace "if prop" logic with existential operator * Remove redundant conditional * feat(upload): itemRender add actions params (#30236) * feat(upload): itemRender add actions params * chore: optimize type definition * chore: update doc * chore: rename actions * chore: trigger ci * chore: rename method name of actions * feat: Add missing dutch translations (#30389) * feat: Add missing dutch translations * fix: Translate remaining english values * fix: Update snapshot for ui tests * test: increase code coverage to 100% (#30415) * test: fix Space code coverage * test: should use nl_BE locale for DatePicker * fix: Switch tabIndex type (#30416) * feat: updated Romanian internationalization (#30419) * feat: updated Romanian internationalization * fixed lint error * feat: Menu support accessibility & keyboard access (#30382) * chore: Use focus style * fix: prefixCls * fix: prefixCls * fix: inline tooltip * fix: inlineCollapse logic * fix: ts definition * test: Update snapshot * test: Update snapshot * fix: dropdown logic * test: Update snapshot * test: Fix some test case * bump rc-menu * test: More test case * fix test finder * test: fix test case * test: Update snapshot * test: Update snapshot * chore: Update ssr effect * test: Update ConfigProvider snapshot * test: Fix Table Filter test case * test: Fix table test case * chore: Update style * chore: beauti css * bump rc-menu * test: update snapshot * test: update snapshot * test: Fix menu test * test: Fix test case * test: Coverage * chore: clean up * bump rc-menu * ehance accessibility style * feat(radioGroup): support data-* and aria-* props (#30507) close #30501 * feat: Typography add italic type (#30458) * Typography增加斜体字支持 * update snapshot * 文档添加版本号 Co-authored-by: lidahao <lidahao@sisyphe.com.cn> * chore: alpha Menu fix merge (#30546) * chore: Update script * bump alpha version * chore: Update script desc * chore: bump rc-tabs & rc-mentions * chore: Adjust style * chore: 4.16.0-alpha.1 * test: Fix mention test case * fix: sider of layout width style * chore: bump 4.16.0-alpha.2 * fix: Tabs tabBarGutter should work as expected (#30545) close #30526 * feat: Table summary support sticky mode (#30631) * chore: Bump rc-table * feat: Patch summary fixed color * fix: style className * test: Update snapshot Co-authored-by: xrkffgg <xrkffgg@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: 二货机器人 <smith3816@gmail.com> Co-authored-by: gepd <guillermoepd@hotmail.com> Co-authored-by: appleshell <appleshell@outlook.com> Co-authored-by: Eric Bonow <ebonow@hotmail.com> Co-authored-by: xrkffgg <xrkffgg@vip.qq.com> Co-authored-by: Kermit <kermitlx@outlook.com> Co-authored-by: Lewis <lewisfidlers@gmail.com> Co-authored-by: afc163 <afc163@gmail.com> Co-authored-by: Ștefan Filip <stefy.filip@gmail.com> Co-authored-by: vldh <alwaysloseall@sina.com> Co-authored-by: lidahao <lidahao@sisyphe.com.cn>
145 lines
6.3 KiB
Markdown
145 lines
6.3 KiB
Markdown
---
|
|
category: Components
|
|
type: General
|
|
title: Typography
|
|
cols: 1
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/GOM1KQ24O/Typography.svg
|
|
---
|
|
|
|
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 | |
|
|
| copyable | Whether to be copyable, customize it via setting an object | boolean \| [copyable](#copyable) | false | [copyable](#copyable) |
|
|
| delete | Deleted line style | boolean | false | |
|
|
| disabled | Disabled content | boolean | false | |
|
|
| editable | If editable. Can control edit state when is object | boolean \| [editable](#editable) | false | [editable](#editable) |
|
|
| ellipsis | Display ellipsis when text overflows | boolean | 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](#copyable) | false | [copyable](#copyable) |
|
|
| delete | Deleted line style | boolean | false | |
|
|
| disabled | Disabled content | boolean | false | |
|
|
| editable | If editable. Can control edit state when is object | boolean \| [editable](#editable) | false | [editable](#editable) |
|
|
| ellipsis | Display ellipsis when text overflows, can configure rows and expandable by using object | boolean \| [ellipsis](#ellipsis) | false | [ellipsis](#ellipsis) |
|
|
| 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](#copyable) | false | [copyable](#copyable) |
|
|
| delete | Deleted line style | boolean | false | |
|
|
| disabled | Disabled content | boolean | false | |
|
|
| editable | If editable. Can control edit state when is object | boolean \| [editable](#editable) | false | [editable](#editable) |
|
|
| ellipsis | Display ellipsis when text overflows, can configure rows and expandable by using object | boolean \| [ellipsis](#ellipsis) | false | [ellipsis](#ellipsis) |
|
|
| 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,
|
|
onCopy: function,
|
|
icon: ReactNode,
|
|
tooltips: false | [ReactNode, ReactNode],
|
|
}
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| 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 | - | |
|
|
|
|
### editable
|
|
|
|
{
|
|
icon: ReactNode,
|
|
tooltip: boolean | ReactNode,
|
|
editing: boolean,
|
|
maxLength: number,
|
|
autoSize: boolean | { minRows: number, maxRows: number },
|
|
onStart: function,
|
|
onChange: function(string),
|
|
onCancel: function,
|
|
onEnd: function,
|
|
}
|
|
|
|
| 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 | boolean \| ReactNode | `Edit` | 4.6.0 |
|
|
| onCancel | Called when type ESC to exit editable state | function | - | |
|
|
| onChange | Called when input at textarea | function(event) | - | |
|
|
| onEnd | Called when type ENTER to exit editable state | function | - | 4.14.0 |
|
|
| onStart | Called when enter editable state | function | - | |
|
|
| onCancel | Called when type ESC to exit editable state | function | - | |
|
|
| onEnd | Called when type ENTER to exit editable state | function | - | |
|
|
|
|
### ellipsis
|
|
|
|
{
|
|
rows: number,
|
|
expandable: boolean,
|
|
suffix: string,
|
|
symbol: ReactNode,
|
|
tooltip: boolean | ReactNode,
|
|
onExpand: function(event),
|
|
onEllipsis: function(ellipsis),
|
|
}
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| expandable | Whether to be expandable | boolean | - | |
|
|
| rows | Max rows of content | number | - | |
|
|
| suffix | Suffix of ellipsis content | string | - | |
|
|
| symbol | Custom description of ellipsis | ReactNode | `Expand` | |
|
|
| tooltip | Show tooltip when ellipsis | boolean \| ReactNode | - | 4.11.0 |
|
|
| onEllipsis | Called when enter or leave ellipsis state | function(ellipsis) | - | 4.2.0 |
|
|
| onExpand | Called when expand content | function(event) | - | |
|
|
|
|
## FAQ
|
|
|
|
### How to use Typography.Link in react-router?
|
|
|
|
`react-router` support [customize](https://github.com/ReactTraining/react-router/blob/master/packages/react-router-dom/docs/api/Link.md#component-reactcomponent) render component:
|
|
|
|
```tsx
|
|
<Link to="/" component={Typography.Link} />
|
|
```
|