# 组件通用说明
每个组件都包含属性、事件和样式。其中大部分功能以及设置方式相同,本节对组件的通用属性做详细说明。
# 属性
# 基础信息
- 组件名称:由字母、数字和下划线组成,用于在表达式中引用、权限上报等场景。
- 是否控制权限:可根据角色设置权限,对无权限的角色的用户隐藏该组件,设置权限前,必须先设置组件名称。
- 显示条件:可通过表达式设置组件显示的条件,当条件为True时显示,为False时隐藏该组件。
# 主要属性
每个组件的主要属性均不相同,这里说明比较通用的属性,组件特有的属性在每个组件的说明文档中详细阐述。
- 设置颜色:不同的组件系统会内置一组场景色,常见的有主要色、成功色、警告色、错误色、危险色等。
- 大小:设置组件大小,常见的有迷你、小、正常、大、巨大。
- 展示方式:行内展示、块级展示(占据整行)。
- 只读:正常显示,但禁止选择或输入。
- 禁用:置灰显示,且禁止任何交互(焦点、点击、选择、输入等)。
- 文本:组件中需要展示的文本内容。
- 动态绑定:组件的所有主要属性都支持动态绑定,可以选择变量,设置表达式。
# 数据属性
数据表格、数据列表等可以设置数据源的组件会有数据属性。不同组件的数据源数据会有一些差别,这里说明比较通用的属性,组件特有的属性在每个组件的说明文档中详细阐述。
- 数据源:组件所展示数据的输入源,可以是逻辑、变量。
- 数据类型:数据源返回的数据的类型。
# 样式属性
字体颜色:支持通过表达式或变量动态控制组件字体颜色,颜色格式常见的表示方法如下:
- 英文表达法:使用英文单词进行颜色的表示,比如red,blue等,该表达方式能直接表示的颜色较少。
- 十六进制表达法:表示形式为“#”加上6位16进制数,如#ffffff。
- RGB表达法:表示形式为rgb(a,b,c),“a”、“b”、“c”三个参数分别表示红,绿,蓝的颜色值,由0到255的十进制表示,如rgb(255,255,0)。
- RGBA表达法:表示形式为rgba(a,b,c,d),“a”、“b”、“c”三个参数分别表示红,绿,蓝的颜色值,由0到255的十进制表示;“d”表示透明度,由0到1之间的小数表示,0为完全透明,1为不透明,如rgba(255,255,0,0.5)。
背景颜色:支持通过表达式或变量动态控制组件背景颜色,颜色格式常见的表示方法如下:
- 英文表达法:使用英文单词进行颜色的表示,比如red,blue等,该表达方式能直接表示的颜色较少。
- 十六进制表达法:表示形式为“#”加上6位16进制数,如#ffffff。
- RGB表达法:表示形式为rgb(a,b,c),“a”、“b”、“c”三个参数分别表示红,绿,蓝的颜色值,由0到255的十进制表示,如rgb(255,255,0)。
- RGBA表达法:表示形式为rgba(a,b,c,d),“a”、“b”、“c”三个参数分别表示红,绿,蓝的颜色值,由0到255的十进制表示;“d”表示透明度,由0到1之间的小数表示,0为完全透明,1为不透明,如rgba(255,255,0,0.5)。
背景图片:支持通过表达式或变量动态控制组件背景图片,填入内容为图片URL。
# 工具属性
- 工具提示:设置提示内容。
- 工具提示弹出方向:设置提示的弹出方向。
工具属性实现效果如下:
# 动态绑定
组件实现将某些属性设置成动态绑定。这些属性可以接受外部数据并展示,外部数据变化的时候,组件也会接收到并更新数据。数据的变化只能从外部到组件内部,组件内部的数据变化不会影响绑定的值,即数据是单项影响。动态绑定的属性可以绑定变量、逻辑、表达式。
# 双向绑定
组件将某些属性设置成双向绑定。这些属性可以接受外部数据并展示,外部数据变化的时候,组件也会接收到并更新数据。组件内部数据变化的时候,该绑定的值的数据也会改变,即数据是双向影响。双向绑定属性只能绑定变量。
# 验证规则
验证规则是表单项的特有属性。验证规则(Rule)通过验证器(或表单项)的rules属性设置。常用验证规则在验证器组件内说明。
# 事件
每个组件有不同的事件,每个事件均可绑定相关逻辑。
# 鼠标事件
与鼠标操作相关的事件
事件名 | 触发条件 |
---|---|
点击 | 鼠标左键单击对应组件 |
双击 | 鼠标左键双击对应组件 |
右键点击 | 鼠标右键单击对应组件 |
鼠标按下 | 鼠标任意键在组件区域内按下 |
鼠标释放 | 鼠标任意键在组件区域内释放 |
鼠标移入 | 鼠标指针移入组件区域 |
鼠标移出 | 鼠标指针移出组件区域 |
# 手势事件
移动端与手势操作相关的事件:
事件名 | 触发条件 |
---|---|
点击 | 手指单击指定区域 |
# 组件事件
组件内部实现的事件。 该类事件为每个组件特有,组件特有的属性在每个组件的说明文档中详细阐述。
# 页面事件
页面实例从开始创建到展示完成有一个完整的过程,这个过程包括开始创建、初始化数据、挂载节点、更新渲染、销毁等。每个过程对应着一些事件,允许自定义事件的处理方法完成一些特定的功能。如在初始化数据的时候,可以传入一些数据处理函数,挂载节点的时候可以得到节点做一些dom节点操作处理。
页面事件主要有:
事件名 | 触发条件 | 其他说明 |
---|---|---|
进入时 | 页面刚打开时 | 只能做一些数据处理,不能获取dom节点进行操作 |
进入后 | 页面节点挂载时 | 可进行数据处理,dom操作 |
更新时 | 页面更新时 | 可进行数据处理,dom操作 |
离开时 | 页面跳转关闭后 | 可进行数据处理,dom操作,主要做一些数据清理操作 |
# 事件逻辑
事件绑定的逻辑。事件逻辑为一个虚拟目录。所有的鼠标事件、手势事件、组件事件、页面事件添加的调用逻辑都在事件逻辑目录下。
# 样式
# 布局
宽度:默认auto(自动),可手动设置宽度,单位为px、百分比。
高度:默认auto(自动),可手动设置高度,单位为px、百分比。
对齐:可选择左对齐、居中对齐、右对齐。
背景颜色:组件的背景颜色,支持点选颜色或直接输入RGB值。
外边距:上下左右四个方向设置组件外部的边距值,单位px。支持开启样式关联,即上下左右边距中一个值发生变化后,其余值会随之变化。
内边距:上下左右四个方向设置组件内部的边距值,单位px。支持开启样式关联,即上下左右边距中一个值发生变化后,其余值会随之变化。
定位模式:支持默认定位、绝对定位、固定定位、相对定位四种模式。
- 默认定位:自适应模式,开启后不显示定位值相关选项。
- 绝对定位:以最近的非默认定位父级组件,来进行相对位置的定位,开启后显示定位值相关选项。
- 固定定位:固定到屏幕某个位置(如底部),不跟随屏幕滚动,开启后显示定位值相关选项。
- 相对定位:以自身位置设置偏移量来定位,开启后显示定位值相关选项。
定位值:支持选择并定义上下左右的边距值,单位为px。
展示层级:定义组件层级关系,层级数越大的展示越靠上。
# 字体
样式:可设置加粗、斜体和下划线。
字号:组件的字体大小。
颜色:组件的字体颜色,支持点选颜色或直接输入RGB值。
# 边框
样式:可选实线或虚线。
颜色:组件边框颜色,支持点选颜色或直接输入RGB值。
线条:设置组件边框的粗细值,单位px。默认开启样式关联,即上下左右中一个值发生变化后,其余值会随之变化。
圆角:设置组件边框的弧度值,单位px。默认开启样式关联,即上下左右中一个值发生变化后,其余值会随之变化。
# 主题样式
组件内部实现的样式,主要以css变量的形式实现,与自定义主题设置相同。通过设置主题样式,可以控制组件内部的样式。
主题样式是组件特有的样式,不同的组件主题样式不一样,组件主题样式在每个组件的说明文档中详细阐述。
# 自定义
支持自定义css样式,例如:
# 组件逻辑
组件内部实现的一些方法,如数据表格的reload等,可供组件外部进行调用。组件内置逻辑在每个组件的说明文档中详细阐述。