amis/docs/zh-CN/components/form/input-datetime-range.md
hsm-lv eb668a7852
Merge pull request #6963 from lurunze1226/inputdate-shortcuts
feat(amis): 日期选择器支持用表达式自定义快捷键
2023-05-31 10:26:30 +08:00

7.2 KiB
Executable File

title description type group menuName icon order
InputDatetimeRange 日期时间范围 0 null InputDatetimeRange 16

基本用法

{
    "type": "form",
    "debug": true,
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-datetime-range",
            "name": "select",
            "label": "日期时间范围"
        }
    ]
}

时间显示到秒

通过 "timeFormat": "HH:mm:ss" 设置时间输入框显示秒

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-datetime-range",
            "name": "select",
            "timeFormat": "HH:mm:ss",
            "label": "日期时间范围"
        }
    ]
}

快捷键

shortcuts属性支持自定义日期时间范围快捷键

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-datetime-range",
            "name": "select",
            "label": "日期范围",
            "shortcuts": "today,yesterday,1dayago,7daysago"
        }
    ]
}

快捷键也支持使用表达式的写法,可以使用这种方式自定义快捷键

3.1.0 及以上版本

{
    "type": "form",
    "debug": true,
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-datetime-range",
            "name": "select",
            "label": "日期范围",
            "inputFormat": "YYYY-MM-DD HH:mm:ss",
            "timeFormat": "HH:mm:ss",
            "format": "x",
            "shortcuts": [
                {
                    "label": "1天前",
                    "startDate": "${DATEMODIFY(NOW(), -1, 'day')}",
                    "endDate": "${NOW()}"
                },
                {
                    "label": "1个月前",
                    "startDate": "${DATEMODIFY(NOW(), -1, 'months')}",
                    "endDate": "${NOW()}"
                },
                {
                    "label": "本季度",
                    "startDate": "${STARTOF(NOW(), 'quarter')}",
                    "endDate": "${ENDOF(NOW(), 'quarter')}"
                }
            ]
        }
    ]
}

属性表

除了支持 普通表单项属性表 中的配置以外,还支持下面一些配置

属性名 类型 默认值 说明 版本
format string X 日期时间选择器值格式
inputFormat string YYYY-MM-DD 日期时间选择器显示格式
placeholder string "请选择日期范围" 占位文本
shortcuts string | string[] | Array<{label: string; startDate: string; endDate: string}> "yesterday,7daysago,prevweek,thismonth,prevmonth,prevquarter" 日期范围快捷键,详情参考快捷键 3.1.0版本后支持表达式
minDate string 限制最小日期时间,用法同 限制范围
maxDate string 限制最大日期时间,用法同 限制范围
utc boolean false 保存 UTC 值
clearable boolean true 是否可清除
animation boolean true 是否启用游标动画 2.2.0

事件表

当前组件会对外派发以下事件,可以通过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,例如 '1650556800,1652889599'