类型定义


类型定义

Resource

资源引用类型,用于设置组件属性的值。

可以通过$r或者$rawfile创建Resource类型对象,不可以修改Resource中的各属性的值。

  • $r('belonging.type.name')

    belonging:系统资源或者应用资源,相应的取值为'sys'和'app';

    type:资源类型,支持'color'、'float'、'string'、'media'等;

    name:资源名称,在资源定义时确定。

  • $rawfile('filename')

    filename:工程中resources/rawfile目录下的文件名称。

    说明: 在引用资源类型时,注意其数据类型要与属性方法本身的类型一致,例如某个属性方法支持设置string | Resource,那么在使用Resource引用类型时,其数据类型也应当为string。

Length

长度类型,用于描述尺寸单位。

类型 说明
string 需要显式指定像素单位,如'10px',也可设置百分比字符串,如'100%'。
number 默认单位vp。
Resource 资源引用类型,引入系统资源或者应用资源中的尺寸。

ResourceStr

字符串类型,用于描述字符串入参可以使用的类型。

类型 说明
string 字符串类型。
Resource 资源引用类型,引入系统资源或者应用资源中的字符串。

Padding

内边距类型,用于描述组件不同方向的内边距。

名称 类型 必填 说明
top Length 上内边距,组件内元素距组件顶部的尺寸。
right Length 右内边距,组件内元素距组件右边界的尺寸。
bottom Length 下内边距,组件内元素距组件底部的尺寸。
left Length 左内边距,组件内元素距组件左边界的尺寸。

Margin

外边距类型,用于描述组件不同方向的外边距。

名称 类型 必填 说明
top Length 上外边距,组件顶部距组件外元素的尺寸。
right Length 右外边距,组件右边界距组件外元素的尺寸。
bottom Length 下外边距,组件底部距组件外元素的尺寸。
left Length 坐外边距,组件左边界距组件外元素的尺寸。

EdgeWidths9+

边框宽度类型,用于描述组件边框不同方向的宽度。

名称 类型 必填 说明
top Length 组件上边框宽度。
right Length 组件右边框宽度。
bottom Length 组件下边框宽度。
left Length 组件左边框宽度。

BorderRadiuses9+

圆角类型,用于描述组件边框圆角半径。

名称 类型 必填 说明
topLeft Length 组件左上角圆角半径。
topRight Length 组件右上角圆角半径。
bottomLeft Length 组件左下角圆角半径。
bottomRight Length 组件右下角圆角半径。

EdgeColors9+

边框颜色,用于描述组件边框四条边的颜色。

名称 类型 必填 说明
top ResourceColor 组件上边框颜色。
right ResourceColor 组件右边框颜色。
bottom ResourceColor 组件下边框颜色。
left ResourceColor 组件左边框颜色。

EdgeStyles9+

边框样式,用于描述组件边框四条边的样式。

名称 类型 必填 说明
top BorderStyle 组件上边框样式。
right BorderStyle 组件右边框样式。
bottom BorderStyle 组件下边框样式。
left BorderStyle 组件左边框样式。

Offset

相对布局完成位置坐标偏移量。

名称 类型 必填 说明
dx Length 水平方向偏移量。
dy Length 竖直方向偏移量。

ResourceColor

颜色类型,用于描述资源颜色类型。

类型 说明
Color 颜色枚举值。
number HEX格式颜色。
string rgb或者rgba格式颜色。
Resource 使用引入资源的方式,引入系统资源或者应用资源中的颜色。

LengthConstrain

长度约束,用于对组件最大、最小长度做限制。

名称 类型 必填 说明
minLength Length 组件最小长度。
maxLength Length 组件最大长度。

Font

设置文本样式。

名称 类型 必填 说明
size Length 设置文本尺寸,Length为number类型时,使用fp单位。不支持设置百分比字符串。
weight FontWeight | number | string 设置文本的字体粗细,number类型取值[100, 900],取值间隔为100,默认为400,取值越大,字体越粗。
family string | Resource 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial, sans-serif'。当前只支持'sans-serif'字体。
style FontStyle 设置文本的字体样式。

Area8+

区域类型,用于存储元素所占区域信息

名称 类型 说明
width Length 目标元素的宽度,作为返回值时,类型为number,单位vp。
height Length 目标元素的高度,作为返回值时,类型为number,单位vp。
position Position 目标元素左上角相对父元素左上角的位置。
globalPosition Position 目标元素左上角相对页面左上角的位置。

Position8+

位置类型,用于表示一个坐标点。

名称 类型 必填 说明
x Length x轴坐标,作为返回值时,类型为number,单位vp。
y Length y轴坐标,作为返回值时,类型为number,单位vp。

ConstraintSizeOptions

设置约束尺寸,组件布局时,进行尺寸范围限制。

名称 类型 必填 说明
minWidth Length 元素最小宽度。
maxWidth Length 元素最大宽度。
minHeight Length 元素最小高度。
maxHeight Length 元素最大高度。

SizeOptions

设置宽高尺寸。

名称 类型 必填 说明
width Length 元素宽度。
height Length 元素高度。

BorderOptions

边框属性集合,用于描述边框相关信息。

名称 类型 必填 说明
width Length | EdgeWidths9+ 边框宽度。
color ResourceColor | EdgeColors9+ 边框颜色。
radius Length | BorderRadiuses9+ 边框圆角半径。
style BorderStyle | EdgeStyles9+ 边框样式。

ColorFilter9+

创建具有4*5矩阵的颜色过滤器。

名称 类型 必填 描述
constructor number[] 创建具有4*5矩阵的颜色过滤器, 入参为[m*n]位于m行和n列中矩阵值, 矩阵是行优先的。

CustomBuilder8+

组件属性方法参数可使用CustomBuilder类型来自定义UI描述。

名称 类型定义 描述
CustomBuilder () => any 该方法类型必须使用@Builder装饰器修饰。具体用法见@Builder