* feat:优化事件数据域 * feat:优化事件数据域 * feat:优化事件数据域(option->item,options->items) * feat:优化事件数据域(version) * feat:优化事件数据域(修复弹窗事件多次触发&并行数据获取问题) * feat:优化事件数据域(删除多余代码) * feat:优化事件数据域(更新文档) * feat:优化事件数据域(更新文档) * feat:优化动作数据域 * feat:优化动作数据域
12 KiB
Executable File
title | description | type | group | menuName | icon | order |
---|---|---|---|---|---|---|
InputDate 日期 | 0 | null | Date | 13 |
基本用法
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "date",
"label": "日期"
}
]
}
显示格式
选中任意日期,可以看到默认显示日期的格式是像2020-04-14
这样的格式,如果你想要自定义显示格式,那么可以配置inputFormat
。
例如你想显示2020年04月14日
这样的格式,查找 moment 文档 可知配置格式应为 YYYY年MM月DD日
,即:
{
"type": "form",
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "date",
"label": "日期",
"inputFormat": "YYYY年MM月DD日"
}
]
}
选中任意日期,观察显示格式
值格式
选中任意日期,可以看到默认表单项的值格式是像1591862818
这样的时间戳格式。
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "date",
"label": "日期"
}
]
}
如果你想要其他格式的日期值,那么可以配置format
参数用于调整表单项的值格式。
例如你调整值为2020-04-14
这样的格式,查找 moment 文档 可知配置格式应为 YYYY-MM-DD
,即:
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "date",
"label": "日期",
"format": "YYYY-MM-DD"
}
]
}
选中任意日期,观察数据域中表单项值的变化
默认值
可以设置value
属性,设置日期选择器的默认值
基本配置
配置符合当前 值格式 的默认值。
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "date",
"label": "日期",
"value": "1591862818"
}
]
}
相对值
value
还支持类似像"+1days"
这样的相对值,更加便捷的配置默认值
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "date",
"label": "日期",
"value": "+1days"
}
]
}
上例中配置了"value": "+1days"
,默认就会选中明天。
支持的相对值关键字有:
today
: 当前日期day
或days
: 天week
或weeks
: 周month
或months
: 月year
或years
: 年
通过公式配置默认值
1.7.0 及以上版本
可以通过日期公式来动态计算。
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "date",
"label": "日期",
"value": "${DATEMODIFY(NOW(), 2, 'days')}"
}
]
}
限制范围
可以通过配置maxDate
和minDate
显示可选范围
固定时间值
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "start",
"label": "开始时间",
"minDate": "1591862818",
"description": "限制可选最小日期是 <code>2020-06-11 16:06:58</code>"
},
{
"type": "input-date",
"name": "end",
"label": "结束时间",
"maxDate": "1591862818",
"description": "限制可选最大日期是 <code>2020-06-11 16:06:58</code>"
}
]
}
支持相对值
范围限制也支持设置 相对值。
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "start",
"label": "开始时间",
"minDate": "-1days",
"description": "限制可选最小日期是昨天"
}
]
}
支持模板
也支持通过模板,设置自定义值。
来一个常见例子,配置两个选择开始时间
和结束时间
的时间选择器,需要满足:开始时间
不能大于结束时间
,结束时间
也不能小于开始时间
。
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "start",
"label": "开始日期",
"maxDate": "$end"
},
{
"type": "input-date",
"name": "end",
"label": "结束日期",
"minDate": "$start"
}
]
}
快捷键
你也可以配置shortcuts
属性支持快捷选择日期
注:移动端 picker 的形式不支持快捷键
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "date",
"label": "日期",
"shortcuts": ["yesterday" ,"today", "tomorrow"]
}
]
}
上例中我们配置了"shortcuts": ["yesterday" ,"today", "tomorrow"]
,选择器顶部有将会显示快捷键昨天
,今天
和明天
支持的快捷键有
today
: 今天yesterday
: 昨天thisweek
: 本周一thismonth
: 本月初prevmonth
: 上个月初prevquarter
: 上个季节初thisquarter
: 本季度初tomorrow
: 明天endofthisweek
: 本周日endofthismonth
:本月底endoflastmonth
:上月底{n}daysago
: n 天前,例如:2daysago
,下面用法相同{n}dayslater
: n 天后{n}weeksago
: n 周前{n}weekslater
: n 周后{n}monthsago
: n 月前{n}monthslater
: n 月后{n}quartersago
: n 季度前{n}quarterslater
: n 季度后
UTC
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "input-date",
"name": "date",
"label": "普通日期",
"format": "YYYY-MM-DD"
},
{
"type": "input-date",
"name": "date-utc",
"label": "UTC日期",
"utc": true,
"format": "YYYY-MM-DD"
}
]
}
内嵌模式
{
"type": "form",
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "static-date",
"name": "date",
"label": "当前值"
},
{
"type": "input-date",
"name": "date",
"label": "日期",
"embed": true
}
]
}
原生日期组件
原生数字日期将直接使用浏览器的实现,最终展现效果和浏览器有关,而且只支持 min
、max
、step
这几个属性设置。
{
"type": "form",
"api": "/api/mock2/form/saveForm",
"body": [
{
"type": "native-date",
"name": "date",
"label": "日期"
}
]
}
属性表
除了支持 普通表单项属性表 中的配置以外,还支持下面一些配置
属性名 | 类型 | 默认值 | 说明 |
---|---|---|---|
value | string |
默认值 | |
format | string |
X |
日期选择器值格式,更多格式类型请参考 文档 |
inputFormat | string |
YYYY-MM-DD |
日期选择器显示格式,即时间戳格式,更多格式类型请参考 文档 |
closeOnSelect | boolean |
false |
点选日期后,是否马上关闭选择框 |
placeholder | string |
"请选择日期" |
占位文本 |
shortcuts | string |
日期快捷键 | |
minDate | string |
限制最小日期 | |
maxDate | string |
限制最大日期 | |
utc | boolean |
false |
保存 utc 值 |
clearable | boolean |
true |
是否可清除 |
embed | boolean |
false |
是否内联模式 |
事件表
当前组件会对外派发以下事件,可以通过onEvent
来监听这些事件,并通过actions
来配置执行的动作,在actions
中可以通过${事件参数名}
来获取事件产生的数据(< 2.3.2 及以下版本 为 ${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 ,例如:'1650556800' |