145 lines
6.6 KiB
Markdown
145 lines
6.6 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 | |
|
|
| mark | Marked style | boolean | false | |
|
|
| strong | Bold style | boolean | false | |
|
|
| type | Content type | `secondary` \| `success` \| `warning` \| `danger` | - | |
|
|
| underline | Underlined style | boolean | false | |
|
|
| content(v-model) | When using ellipsis or editable, use content instead of children | string | - | |
|
|
|
|
### 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 | |
|
|
| mark | Marked style | boolean | false | |
|
|
| type | Content type | `secondary` \| `success` \| `warning` \| `danger` | - | |
|
|
| underline | Underlined style | boolean | false | |
|
|
| content(v-model) | When using ellipsis or editable, use content instead of children | string | - | |
|
|
|
|
### 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 | |
|
|
| strong | Bold style | boolean | false | |
|
|
| type | Content type | `secondary` \| `success` \| `warning` \| `danger` | - | |
|
|
| underline | Underlined style | boolean | false | |
|
|
| content(v-model) | When using ellipsis or editable, use content instead of children | string | - | |
|
|
|
|
### slots
|
|
|
|
| Name | Description | Property | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| editableIcon | Custom editable icon | - | <EditOutlined /> | |
|
|
| editableTooltip | Custom tooltip text, hide when `editable.tooltip = false` | - | `Edit` | |
|
|
| copyableIcon | Custom copy icon | `{ copied: boolean }` | `copied ? <CheckOutlined /> : <CopyOutlined />` | |
|
|
| copyableTooltip | Custom tooltip text, hide when `copyable.tooltip = false` | `{ copied: boolean }` | `copied ? 'Copied' : 'Copy'` | |
|
|
| ellipsisSymbol | Custom description of ellipsis | - | - | |
|
|
| ellipsisTooltip | Show tooltip when ellipsis | - | - | |
|
|
|
|
### copyable
|
|
|
|
```json
|
|
{
|
|
text: string,
|
|
onCopy: function,
|
|
tooltip: false,
|
|
}
|
|
```
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| -------- | ----------------------- | -------- | ------- | ------- |
|
|
| text | The text to copy | string | - | |
|
|
| tooltip | Whether to show tooltip | boolean | true | |
|
|
| onCopy | Called when copied text | function | - | |
|
|
|
|
### editable
|
|
|
|
```json
|
|
{
|
|
tooltip: boolean,
|
|
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 } | - | |
|
|
| editing | Whether to be editable | boolean | false | |
|
|
| maxlength | `maxlength` attribute of textarea | number | - | |
|
|
| tooltip | Whether to show tooltip | boolean | true | |
|
|
| 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 | - | |
|
|
| 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
|
|
|
|
```json
|
|
{
|
|
rows: number,
|
|
expandable: boolean,
|
|
suffix: string,
|
|
symbol: string,
|
|
tooltip: boolean | string,
|
|
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 | string | `Expand` | |
|
|
| tooltip | Show tooltip when ellipsis | boolean \| string | - | |
|
|
| onEllipsis | Called when enter or leave ellipsis state | function(ellipsis) | - | |
|
|
| onExpand | Called when expand content | function(event) | - | |
|