Skip to content

TextEllipsis 文本省略

对长文本进行省略,支持展开/收起。

基础用法

展开/收起

自定义展示行数

使用 html 片段作为文本

使用 icon 图标

API

Props

参数说明类型默认值
rows展示的行数number | string1
content需要展示的文本string-
expand-text展开操作的文案,当textType=icon时,等同 iconstring | Component-
collapse-text收起操作的文案,当textType=icon时,等同 iconstring | Component-
is-text-right操作的文档是否右对齐booleanfalse
is-html展示的文本是否是 htmlbooleanfalse
text-type操作文案的暂时类型,可选iconstringtext
default-expanded默认是否展开文本booleanfalse
dots省略号的文本内容string'...'

Events

事件名说明回调参数
click-action点击展开/收起时触发event: MouseEvent

TextEllipsis 方法

通过 ref 可以获取到 TextEllipsis 实例并调用实例方法,详见组件实例方法

方法名说明参数返回值
toggle切换文本的展开状态,传 true 为展开,false 为收起,不传参为切换expanded?: boolean-

类型定义

组件导出以下类型定义:

ts
import type {
  TextEllipsisProps,
  TextEllipsisInstance,
  TextEllipsisThemeVars
} from 'ryxon'

TextEllipsisInstance 是组件实例的类型,用法如下:

ts
import { ref } from 'vue'
import type { TextEllipsisInstance } from 'ryxon'

const textEllipsisRef = ref<TextEllipsisInstance>()

textEllipsisRef.value?.toggle()

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--r-text-ellipsis-font-size14px文本的字体大小
--r-text-ellipsis-line-height1.6文本的行高
--r-text-ellipsis-action-colorvar(--r-primary-color)操作按钮的颜色

Released under the MIT License.