mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-02 20:19:44 +08:00
cbcfd38ca7
* build: try to use dumi as doc tool * docs: migrate demo structure to dumi way * refactor: use type export & import * docs: migrate demo previewer to dumi * docs: create empty layout & components * docs: apply custom rehype plugin * docs: create empty extra pages * docs: Add Banner component * chore: move theme tsconfig.json * docs: home page init * docs: migrate header (#37896) * docs: header * docs: update * docs: home init * clean up * test: fix site lint * chore: tsc ignore demo * chore: dumi demo migrate script * chore: cards * docs: home layout * docs: Update locale logic * docs: fix getLink logic * chore: fix ci (#37899) * chore: fix ci * ci: remove check-ts-demo * ci: preview build * test: ignore demo.tsx * chore: update script * test: update snapshot * test: update node and image test * chore: add .surgeignore * docs: layout providers (#37908) * docs: add components sidebar (#37923) * docs: sidebar * docs: update docs title * docs: update design doc * chore: code clean * docs: handle changelog page * docs: add title * docs: add subtitle * docs: active header nav * chore: code clean * docs: overview * chore: code clean * docs: update intl (#37918) * docs: update intl * chore: code clean * docs: update favicons * chore: update testPathIgnorePatterns * chore: code clean * chore: code clean * chore: copy 404.html (#37996) * docs: Home page theme picker * chore: Update migrate script * docs: home page update * docs: theme editor style * docs: theme lang * chore: update migrate.js * docs: fix demo (#38094) * chore: update migrate.js * docs: update md * docs: update demo * test: fix snapshot * chore: move debug to code attr in migrate script * chore: update md Co-authored-by: PeachScript <scdzwyxst@gmail.com> * feat: overview page * feat: Migrate `404` page (#38118) * feat: migrate IconSearch component (#37916) * feat<site/IconSearch>: copy IconDisplay from site to .dumi * feat<site/IconSearch>: change docs of icon * feat<site/IconSearch>: tweak * feat<site/IconSearch>: use useIntl instead of injectIntl * feat<site/IconSearch>: fix ts type error * feat<site/IconSearch>: use intl.formatMessage to render text * docs: Adjust home btn sizw * docs: Update doc * feat: v5 site overview page (#38131) * feat: site * fix: fix * feat: v5 site overview page * fix: fix path * fix: fix * fix: fix * docs: fix margin logic * feat: v5 site change-log page (#38137) * feat: v5 site change-log page (#38162) * docs: site redirect to home pag * docs: theme picker * docs: use react-intl from dumi (#38183) * docs: Theme Picker * docs: update dumi config * docs: home back fix * docs: picker colorful * docs: locale of it * docs: update components desc * docs: site of links * docs: update components list * docs: update desc * feat: Migrate `DemoWrapper` component (#38166) * feat: Migrate `DemoWrapper` component * feat: remove invalid comments and add comment for `key` prop * docs: FloatButton pure panel * chore: update demo * chore: update dumi config * Revert "chore: update demo" This reverts commit 028265d3ba5987df5f13c3e9d42cf76cb1812b2e. * chore: test logic adjust to support cnpm modules * chore: add locale alias * docs: /index to / * docs: add locale redirect head script * chore: adjust compact * docs: fix missing token * feat: compact switch * chore: code clean * docs: update home * docs: fix radius token * docs: hash of it * chore: adjust home page * docs: Add background map * docs: site theme bac logic * docs: avatar * docs: update logo color * docs: home banner * docs: adjust tour size * docs: purepanl update * docs: transfooter * docs: update banner gif * docs: content (#38361) * docs: title & EditButton * docs: content * chore: fix toc * docs: resource page * docs: transform resource data from hast * docs: filename & Resource Card * chore: enable prerender * chore: remove less * docs: toc style * chore: fix lint * docs: fix Layout page * docs: fix CP page * chore: update demos * docs: workaround for export dynamic html * chore: enable demo eslint * docs: table style * fix: header shadow * chore: update snapshot * fix: toc style * docs: add title * docs: Adjust site * feat: helmet * docs: site css * fix: description * feat: toc debug * docs: update config-provider * feat: use colorPanel * fix: colorPanel value * feat: anchor ink ball style * feat: apply theme editor * fix: code block style * chore: update demo * chore: fix lint * chore: code clean * chore: update snapshot * feat: ts2js * chore: description * docs: site ready for ssr includes: - move client render logic to useEffect in site theme - extract antd cssinjs to a single css file like bisheng - workaround to support react@18 pipeableStream for emotion * chore: bump testing lib * docs: font size of title * chore: remove react-sortable-hoc * chore: update snapshot * chore: update script Co-authored-by: PeachScript <scdzwyxst@gmail.com> Co-authored-by: MadCcc <1075746765@qq.com> Co-authored-by: zqran <uuxnet@gmail.com> Co-authored-by: TrickyPi <530257315@qq.com> Co-authored-by: lijianan <574980606@qq.com>
166 lines
18 KiB
Markdown
166 lines
18 KiB
Markdown
---
|
||
category: Components
|
||
group: General
|
||
title: Typography
|
||
cover: https://gw.alipayobjects.com/zos/alicdn/GOM1KQ24O/Typography.svg
|
||
demo:
|
||
cols: 2
|
||
---
|
||
|
||
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.
|
||
|
||
## Examples
|
||
|
||
<code src="./demo/basic.tsx">Basic</code>
|
||
<code src="./demo/title.tsx">Title Component</code>
|
||
<code src="./demo/paragraph-debug.tsx" debug>Title and Paragraph</code>
|
||
<code src="./demo/text.tsx">Text and Link Component</code>
|
||
<code src="./demo/interactive.tsx">Interactive</code>
|
||
<code src="./demo/ellipsis.tsx">Ellipsis</code>
|
||
<code src="./demo/ellipsis-middle.tsx">Ellipsis from middle</code>
|
||
<code src="./demo/ellipsis-debug.tsx" debug>Ellipsis Debug</code>
|
||
<code src="./demo/suffix.tsx">suffix</code>
|
||
|
||
## 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，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 manually | boolean \| [Omit<ellipsis, 'expandable' \| 'rows' \| 'onExpand'>](#ellipsis) | false | [ellipsis](#ellipsis) |
|
||
| 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(event),
|
||
icon: ReactNode,
|
||
tooltips: false | [ReactNode, ReactNode],
|
||
format: 'text/plain' | 'text/html',
|
||
}
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| -------- | ------------------------------------------ | --------------------------- | ------------------- | ------- |
|
||
| format | The Mime Type of the text | 'text/plain' \| 'text/html' | - | 4.21.0 |
|
||
| 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 },
|
||
text: string,
|
||
onChange: function(string),
|
||
onCancel: function,
|
||
onStart: function,
|
||
onEnd: function,
|
||
triggerType: ('icon' | 'text')[],
|
||
enterIcon: ReactNode,
|
||
}
|
||
|
||
| 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 |
|
||
| text | Edit text, specify the editing content instead of using the children implicitly | string | - | 4.24.0 |
|
||
| onChange | Called when input at textarea | function(value: string) | - | |
|
||
| onCancel | Called when type ESC to exit editable state | function | - | |
|
||
| onStart | Called when enter editable state | function | - | |
|
||
| onEnd | Called when type ENTER to exit editable state | function | - | 4.14.0 |
|
||
| triggerType | Edit mode trigger - icon, text or both (not specifying icon as trigger hides it) | Array<`icon`\|`text`> | \[`icon`] | |
|
||
| enterIcon | Custom "enter" icon in the edit field (passing `null` removes the icon) | ReactNode | `<EnterOutlined />` | 4.17.0 |
|
||
|
||
### ellipsis
|
||
|
||
{
|
||
rows: number,
|
||
expandable: boolean,
|
||
suffix: string,
|
||
symbol: ReactNode,
|
||
tooltip: boolean | ReactNode | TooltipProps,
|
||
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 \| [TooltipProps](/components/tooltip/#API) | - | 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} />
|
||
```
|
||
|
||
**Note：** This is not equivalent to the execution logic of react-router's Link [reference](https://github.com/ant-design/ant-design/pull/26737/files#r488769888)
|