Skip to content

Commit

Permalink
docs: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@ruofee
ruofee committed Aug 19, 2024
1 parent a407979 commit 7e2dfb0
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions docs/api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

## Props

| 属性名 | 类型 | 默认值 | 描述 |
| ----------------- | ----------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| text | string | Required | 需要进行缩略的文本 |
| visibleLine | number | 1 | 文本可见行数；超过该行数时文本会进行裁剪。`visibleLine` 不可大于 `maxLine` |
| visibleHeight | number | | 文本可见高度；超过该高度时文本会进行裁剪，优先级高于 `visibleLine`。`visibleHeight` 不可大于 `maxHeight` |
| ellipsis | boolean | true | 是否开启缩略 |
| ellipsisNode | string | ... | 自定义缩略符 |
| unellipsisNode | string | | 自定义**未缩略符**，仅当 `ellipsis` 为 false 时生效，vue-ellipsis-3 暂未支持 |
| endExcludes | Array<string \| RegExp> | [] | 结尾处希望被过滤掉的字符（在缩略符之前），支持传入字符串和正则表达式 |
| useInnerHtml | boolean | false | 将 `text` 当做 HTML 进行缩略（请确保传递的 text 安全可靠，否则可能导致 XSS 安全问题） |
| maxLine | number | | 和 `visibleLine` 配合使用，当行数超过 `maxLine` 时缩略成 `visibleLine` 行，具体查看：[超过 n 行时展示 m 行](/usage/#比较少见的功能-超过-n-行时展示-m-行) |
| maxHeight | number | | 和 `visibleHeight` 配合使用，当文本高度超过 `maxHeight` 时缩略成 `visibleHeight`，具体查看：[超过高度 n 时，展示高度 m](/usage/#姐妹需求-超过高度-n-时-展示高度-m) |
| reflowOnResize | boolean | | 容器大小改变时是否重新布局，原生缩略支持时默认是 true，否则为 false |
| onReflow | (ellipsis: boolean, text: string) => void | | 重排完成回调事件。参数 `ellipsis` 表示文本是否被截断；参数 `text` 为可见文本（不包含缩略符） |
| onEllipsisClick | () => void | | 缩略符点击回调事件 |
| onUnellipsisClick | () => void | | **未缩略符**点击事件，vue-ellipsis-3 暂未支持 |
| 属性名 | 类型 | 默认值 | 描述 |
| ----------------- | ----------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| text | string | Required | 需要进行缩略的文本 |
| visibleLine | number | 1 | 文本可见行数；超过该行数时文本会进行裁剪。`visibleLine` 不可大于 `maxLine` |
| visibleHeight | number | | 文本可见高度；超过该高度时文本会进行裁剪，优先级高于 `visibleLine`。`visibleHeight` 不可大于 `maxHeight` |
| ellipsis | boolean | true | 是否开启缩略 |
| ellipsisNode | string | ... | 自定义缩略符 |
| unellipsisNode | string | | 自定义**未缩略符**，仅当 `ellipsis` 为 false 时生效 |
| endExcludes | Array<string \| RegExp> | [] | 结尾处希望被过滤掉的字符（在缩略符之前），支持传入字符串和正则表达式 |
| useInnerHtml | boolean | false | 将 `text` 当做 HTML 进行缩略（请确保传递的 text 安全可靠，否则可能导致 XSS 安全问题） |
| maxLine | number | | 和 `visibleLine` 配合使用，当行数超过 `maxLine` 时缩略成 `visibleLine` 行，具体查看：[超过 n 行时展示 m 行](/usage/#%E6%AF%94%E8%BE%83%E5%B0%91%E8%A7%81%E7%9A%84%E5%8A%9F%E8%83%BD-%E8%B6%85%E8%BF%87-n-%E8%A1%8C%E6%97%B6%E5%B1%95%E7%A4%BA-m-%E8%A1%8C) |
| maxHeight | number | | 和 `visibleHeight` 配合使用，当文本高度超过 `maxHeight` 时缩略成 `visibleHeight`，具体查看：[超过高度 n 时，展示高度 m](/usage/#%E5%A7%90%E5%A6%B9%E9%9C%80%E6%B1%82-%E8%B6%85%E8%BF%87%E9%AB%98%E5%BA%A6-n-%E6%97%B6-%E5%B1%95%E7%A4%BA%E9%AB%98%E5%BA%A6-m) |
| reflowOnResize | boolean | | 容器大小改变时是否重新布局，原生缩略支持时默认是 true，否则为 false |
| onReflow | (ellipsis: boolean, text: string) => void | | 重排完成回调事件。参数 `ellipsis` 表示文本是否被截断；参数 `text` 为可见文本（不包含缩略符） |
| onEllipsisClick | () => void | | 缩略符点击回调事件 |
| onUnellipsisClick | () => void | | **未缩略符**点击事件 |

## Slots

Expand Down

0 comments on commit 7e2dfb0

Please sign in to comment.