8.1 KiB
Executable File
title | description | type | group | menuName | icon | order |
---|---|---|---|---|---|---|
InputTime 时间 | 0 | null | InputTime 时间 | 58 |
基本用法
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-time",
"name": "time",
"label": "时间"
}
]
}
显示格式
选中任意时间,可以看到默认显示时间的格式是像01:01
这样的格式,如果你想要自定义显示格式,那么可以配置displayFormat
。
例如你想显示01时01分
这样的格式,查找 moment 文档可知配置格式应为 HH时mm分
,即:
{
"type": "form",
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-time",
"name": "time",
"label": "时间",
"displayFormat": "HH时mm分"
}
]
}
调整时间,观察显示格式
值格式
选中任意时间,可以看到默认表单项的值格式是像1591862818
这样的时间戳格式。
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-time",
"name": "time",
"label": "时间"
}
]
}
如果你想要其他格式的日期值,那么可以配置valueFormat
参数用于调整表单项的值格式。
例如你调整值为01:11
这样的格式,查找 moment 文档可知配置格式应为 HH:mm
,即:
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-time",
"name": "time",
"label": "时间",
"valueFormat": "HH:mm"
}
]
}
调整时间,观察数据域中表单项值的变化
显示秒
默认显示的是时和分,要显示秒可通过配置displayFormat
实现,请参考以下配置,若配置valueFormat
需与displayFormat
精确度相同
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-time",
"name": "time",
"label": "时间",
"valueFormat": "HH:mm:ss",
"displayFormat": "HH:mm:ss"
},
{
"type": "input-time",
"name": "time2",
"label": "时间2",
"displayFormat": "HH:mm:ss"
}
]
}
默认值
可以设置value
属性,设置日期选择器的默认值
基本配置
配置符合当前 值格式 的默认值。
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-time",
"name": "time",
"label": "时间",
"value": "1591862818"
}
]
}
相对值
value
还支持类似像"+1hours"
这样的相对值,更加便捷的配置默认值
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-time",
"name": "time",
"label": "时间",
"value": "+1hours"
}
]
}
上例中配置了"value": "+1hours"
,默认就会选中一小时后。
支持的相对值关键字有:
now
: 当前时间hour
或hours
: 时minute
或minutes
: 分second
或seconds
: 秒
控制输入范围
通过 timeConstraints
属性可以控制输入范围
默认值是
{
"hours": {
"min": 0,
"max": 23,
"step": 1
},
"minutes": {
"min": 0,
"max": 59,
"step": 1
},
"seconds": {
"min": 0,
"max": 59,
"step": 1
},
"milliseconds": {
"min": 0,
"max": 999,
"step": 1
}
}
可以只修改其中的部分值,比如下面的示例将分钟每次加减改成了 15,小时的范围限制在 9 到 17
设置了
timeConstraints
后,点击「此刻」会选择最接近当前时间的有效值
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-time",
"name": "time",
"label": "时间",
"timeConstraints": {
"hours": {
"min": 9,
"max": 17
},
"minutes": {
"step": 15
}
}
}
]
}
原生时间组件
原生时间组件将直接使用浏览器的实现,最终展现效果和浏览器有关,而且只支持 min
、max
、step
这几个属性设置。
{
"type": "form",
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "native-time",
"name": "time",
"label": "时间"
}
]
}
属性表
除了支持 普通表单项属性表 中的配置以外,还支持下面一些配置
属性名 | 类型 | 默认值 | 说明 | 版本 |
---|---|---|---|---|
value | string |
默认值 | ||
valueFormat | string |
X |
时间选择器值格式,更多格式类型请参考 moment | 3.4.0 版本后支持 |
displayFormat | string |
HH:mm |
时间选择器显示格式,即时间戳格式,更多格式类型请参考 moment | 3.4.0 版本后支持 |
placeholder | string |
"请选择时间" |
占位文本 | |
clearable | boolean |
true |
是否可清除 | |
timeConstraints | object |
true |
事件表
当前组件会对外派发以下事件,可以通过onEvent
来监听这些事件,并通过actions
来配置执行的动作,在actions
中可以通过${事件参数名}
或${event.data.[事件参数名]}
来获取事件产生的数据,详细请查看事件动作。
[name]
表示当前组件绑定的名称,即name
属性,如果没有配置name
属性,则通过value
取值。
事件名称 | 事件参数 | 说明 |
---|---|---|
change | [name]: string 组件的值 |
时间值变化时触发 |
focus | [name]: string 组件的值 |
输入框获取焦点(非内嵌模式)时触发 |
blur | [name]: string 组件的值 |
输入框失去焦点(非内嵌模式)时触发 |
动作表
当前组件对外暴露以下特性动作,其他组件可以通过指定actionType: 动作名称
、componentId: 该组件id
来触发这些动作,动作配置可以通过args: {动作配置项名称: xxx}
来配置具体的参数,详细请查看事件动作。
动作名称 | 动作配置 | 说明 |
---|---|---|
clear | - | 清空 |
reset | - | 将值重置为resetValue ,若没有配置resetValue ,则清空 |
setValue | value: string 更新的时间值 |
更新数据,依赖格式format ,例如:'1648746120' |