components/typography/index.en-US.md
<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/editable.tsx">Editable</code> <code src="./demo/copyable.tsx">Copyable</code> <code src="./demo/ellipsis.tsx">Ellipsis</code> <code src="./demo/ellipsis-controlled.tsx" version="5.16.0">Controlled ellipsis expand/collapse</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> <code src="./demo/componentToken-debug.tsx" debug>Component Token</code> <code src="./demo/link-danger-debug.tsx" debug>Link danger Debug</code>
Common props ref:Common props
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| code | Code style | boolean | false | |
| copyable | Whether to be copyable, customize it via setting an object | boolean | copyable | false | |
| delete | Deleted line style | boolean | false | |
| disabled | Disabled content | boolean | false | |
| editable | If editable. Can control edit state when is object | boolean | editable | false | |
| 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'> | 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 |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| code | Code style | boolean | false | |
| copyable | Whether to be copyable, customize it via setting an object | boolean | copyable | false | |
| delete | Deleted line style | boolean | false | |
| disabled | Disabled content | boolean | false | |
| editable | If editable. Can control edit state when is object | boolean | editable | false | |
| ellipsis | Display ellipsis when text overflows, can configure rows and expandable by using object | boolean | ellipsis | false | |
| 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 |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| code | Code style | boolean | false | |
| copyable | Whether to be copyable, customize it via setting an object | boolean | copyable | false | |
| delete | Deleted line style | boolean | false | |
| disabled | Disabled content | boolean | false | |
| editable | If editable. Can control edit state when is object | boolean | editable | false | |
| ellipsis | Display ellipsis when text overflows, can configure rows and expandable by using object | boolean | ellipsis | false | |
| 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 |
{
text: string | (() => string | Promise<string>),
onCopy: function(event),
icon: ReactNode,
tooltips: false | [ReactNode, ReactNode],
format: 'text/plain' | 'text/html',
tabIndex: number,
}
| 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 | - | |
| tabIndex | Set tabIndex of the copy button | number | 0 | 5.17.0 |
{
icon: ReactNode,
tooltip: 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,
tabIndex: number,
}
| 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 | 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 |
| tabIndex | Set tabIndex of the edit button | number | 0 | 5.17.0 |
interface EllipsisConfig {
rows: number;
/** `collapsible` added in `5.16.0` */
expandable: boolean | 'collapsible';
suffix: string;
/** render function added in `5.16.0` */
symbol: ReactNode | ((expanded: boolean) => ReactNode);
tooltip: ReactNode | TooltipProps;
/** added in `5.16.0` */
defaultExpanded: boolean;
/** added in `5.16.0` */
expanded: boolean;
/** `info` added in `5.16.0` */
onExpand: (event: MouseEvent, info: { expanded: boolean }) => void;
onEllipsis: (ellipsis: boolean) => void;
}
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| expandable | Whether to be expandable | boolean | 'collapsible' | - | collapsible: 5.16.0 |
| rows | Max rows of content | number | - | |
| suffix | Suffix of ellipsis content | string | - | |
| symbol | Custom description of ellipsis | ReactNode | ((expanded: boolean) => ReactNode) | Expand Collapse | |
| tooltip | Show tooltip when ellipsis | ReactNode | TooltipProps | - | 4.11.0 |
| defaultExpanded | Default expand or collapse | boolean | 5.16.0 | |
| expanded | Expand or Collapse | boolean | 5.16.0 | |
| onEllipsis | Called when enter or leave ellipsis state | function(ellipsis) | - | 4.2.0 |
| onExpand | Called when expand content | function(event, { expanded: boolean }) | - | info: 5.16.0 |
<ComponentTokenTable component="Typography"></ComponentTokenTable>