Text 元素

绘制文本。与 HTML5 文本显示效果基本一致，支持多行文本。

继承

Text  >  UI

关键属性

width?: number

文本框宽度，不设置时为自动宽度。

height?: number

文本框高度，不设置时为自动高度。

text: string | number

文本内容。

样式属性

fontFamily: string

字体， 同 css，多个字体用逗号隔开。

fontSize: number

文字大小。

fontWeight: IFontWeightNumer | IFontWeightString

文字粗细。

type IFontWeightNumer = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900

type IFontWeightString =
  | 'thin' // 100
  | 'extra-light' // 200
  | 'light' // 300
  | 'normal' // 400
  | 'medium' // 500
  | 'semi-bold' // 600
  | 'bold' // 700
  | 'extra-bold' // 800
  | 'black' // 900

italic: boolean

文字是否倾斜。

textCase: ITextCase

文字大小写格式。

type ITextCase =
  | 'title' // 单词首字母大写
  | 'upper' // 全部大写
  | 'lower' // 全部小写
  | 'none'

textDecoration: ITextDecoration

文字下划线或删除线。

type ITextDecoration =
  | 'under' // 下划线
  | 'delete' // 删除线
  | 'none'

letterSpacing: number | IUnitData

字间距，可使用百分比类型， 默认为 0。

interface IUnitData {
  type: 'percent' ｜ 'px'
  value: number
}

text.letterSpacing = {
  type: 'percent',
  value: 0.5, // 50%
}

lineHeight: number ｜ IUnitData

行间距，可使用百分比类型, 默认行高为 150%。

text.lineHeight = {
  type: 'percent',
  value: 1.5, // 150%
}

textWrap: ITextWrap

文本换行规则， 默认为 normal。

type ITextWrap =
｜'normal'  // 在允许的换行点自动换行，不断开word
| 'none'  // 强制不换行
| 'break' // 可断开word换行，类似 CSS 的 break-all

textOverflow: IOverflow ｜ string

如何显示超出固定宽高的文本, 可自定义省略文本。

type IOverflow = 'show' | 'hide'

// 自定义省略文本

text.textOverflow = '...'

段落属性

paraIndent: number

段落首行缩进，单位为 px。

TIP

在 HTML5 中编辑文本时需将\n替换为<p>标签，段落样式在<p>标签上进行设置。

paraSpacing: number

段落间距，单位为 px。

textAlign: ITextAlign

文本对齐方式，可以设置 'both' 来强制两端对齐文本。

type ITextAlign =
  | 'left' // 左对齐
  | 'center' // 居中对齐
  | 'right' // 右对齐
  | 'justify' // 两端对齐段落
  | 'both' // 强制两端对齐文本，补充 justify 的不足

verticalAlign: IVerticalAlign

文本垂直对齐。

type IVerticalAlign =
  | 'top' // 顶部对齐
  | 'middle' // 垂直居中对齐
  | 'bottom' // 底部对齐

autoSizeAlign: boolean

当文本没有宽高且有对齐属性时，是否对齐起点坐标，默认为 true。

如希望文本位置从起点坐标开始，可设为 false。

padding: number | number[]

文本内边距，可分别设置 4 个值。

padding: [20, 10, 20, 10] // [top, right, bottom, left]
padding: [20, 10, 20] // [top, (right-left), bottom]
padding: [20, 10] // [ (top-bottom), (right-left)]
padding: 20 // all

编辑属性

resizeFontSize: boolean

自动宽高的文本是否通过修改字体大小进行 resize, 默认为 false。

示例

创建文本

// #创建 Text [标准创建]
import { Leafer, Text } from 'leafer-ui'

const leafer = new Leafer({ view: window })

const text = new Text({
    fill: '#32cd79',
    text: 'Welcome to LeaferJS',
})

leafer.add(text)

创建自适应背景的文本

Box 不设置宽高时，支持自适应内容。

// #创建 Box [自适应文本]
import { Leafer, Box } from 'leafer-ui'

const leafer = new Leafer({ view: window, fill: '#333' })

// Box 不设置宽高时，将自适应内容
const box = new Box({
    x: 100,
    y: 100,
    fill: '#FF4B4B',
    cornerRadius: 20,
    children: [{
        tag: 'Text',
        text: 'Welcome to LeaferJS',
        fill: 'black',
        padding: [10, 20],
        textAlign: 'left',
        verticalAlign: 'top'
    }]
})

leafer.add(box)

文本 count 动画

text 属性传入数字，可支持 count 动画，示例中的文本将从 0 到 100 动态变化。

// #动画样式 [文本count动画]
import { Leafer, Text } from 'leafer-ui'
import '@leafer-in/animate' // 导入动画插件

const leafer = new Leafer({ view: window })

const text = new Text({
    fill: '#32cd79',
    text: 0,
    animation: {
        style: { text: 100 },
        duration: 2
    }
})

leafer.add(text)

打字机动画

// #动画样式 [打字机动画]
import { Leafer, Text } from 'leafer-ui'
import '@leafer-in/animate' // 导入动画插件

const leafer = new Leafer({ view: window })

const text = new Text({
    fill: '#32cd79',
    animation: {
        style: { text: 'Welcome to LeaferJS' },
        duration: 2,
    }
})

leafer.add(text)

删除文字动画

// #动画样式 [删除文本动画]
import { Leafer, Text } from 'leafer-ui'
import '@leafer-in/animate' // 导入动画插件

const leafer = new Leafer({ view: window })

const text = new Text({
    fill: '#32cd79',
    text: 'Welcome to LeaferJS',
    animation: {
        style: { text: '' },
        duration: 2,
    }
})

leafer.add(text)