mirror of
https://gitee.com/baidu/amis.git
synced 2024-12-14 08:51:24 +08:00
175 lines
5.6 KiB
Markdown
Executable File
175 lines
5.6 KiB
Markdown
Executable File
---
|
|
title: InputMonth 月份
|
|
description:
|
|
type: 0
|
|
group: null
|
|
menuName: InputMonth 月份
|
|
icon:
|
|
order: 81
|
|
---
|
|
|
|
## 基本用法
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "form",
|
|
"api": "/api/mock2/form/saveForm",
|
|
"body": [
|
|
{
|
|
"type": "input-month",
|
|
"name": "month",
|
|
"label": "时间"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## 显示格式
|
|
|
|
选中月份，可以看到默认显示月份的格式是像`01`这样的格式，如果你想要自定义显示格式，那么可以配置`inputFormat`。
|
|
|
|
例如你想显示`01月`这样的格式，查找 moment 文档可知配置格式应为 `MM月`，即：
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "form",
|
|
"api": "/api/mock2/form/saveForm",
|
|
"body": [
|
|
{
|
|
"type": "input-month",
|
|
"name": "month",
|
|
"label": "月份",
|
|
"inputFormat": "MM月"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
调整月份，观察显示格式
|
|
|
|
## 值格式
|
|
|
|
选中任意月份，可以看到默认表单项的值格式是像`1582992000`这样的时间戳格式。
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "form",
|
|
"debug": true,
|
|
"api": "/api/mock2/form/saveForm",
|
|
"body": [
|
|
{
|
|
"type": "input-month",
|
|
"name": "month",
|
|
"label": "月份"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
如果你想要其他格式的月份值，那么可以配置`format`参数用于调整表单项的值格式。
|
|
|
|
例如你调整值为`01`这样的格式，查找 moment 文档可知配置格式应为 `MM`，即：
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "form",
|
|
"debug": true,
|
|
"api": "/api/mock2/form/saveForm",
|
|
"body": [
|
|
{
|
|
"type": "input-month",
|
|
"name": "month",
|
|
"label": "月份",
|
|
"format": "MM"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
调整月份，观察数据域中表单项值的变化
|
|
|
|
## 默认值
|
|
|
|
可以设置`value`属性，设置月份选择器的默认值
|
|
|
|
### 基本配置
|
|
|
|
配置符合当前 [值格式](./date#%E5%80%BC%E6%A0%BC%E5%BC%8F) 的默认值。
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "form",
|
|
"debug": true,
|
|
"api": "/api/mock2/form/saveForm",
|
|
"body": [
|
|
{
|
|
"type": "input-month",
|
|
"name": "month",
|
|
"label": "月份",
|
|
"value": "1582992000"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### 相对值
|
|
|
|
`value` 还支持类似像`"+1hours"`这样的相对值，更加便捷的配置默认值
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "form",
|
|
"debug": true,
|
|
"api": "/api/mock2/form/saveForm",
|
|
"body": [
|
|
{
|
|
"type": "input-month",
|
|
"name": "month",
|
|
"label": "月份",
|
|
"value": "+1month"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
上例中配置了`"value": "+1month"`，默认就会选中一个月后。
|
|
|
|
支持的相对值关键字有：
|
|
|
|
- `now`: 当前时间
|
|
- `hour`或`hours`: 时
|
|
- `minute`或`minutes`: 分
|
|
- `second`或`seconds`: 秒
|
|
|
|
## 属性表
|
|
|
|
除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置
|
|
|
|
| 属性名 | 类型 | 默认值 | 说明 |
|
|
| ----------- | --------- | -------------- | ----------------------------------------------------------------------------------- |
|
|
| value | `string` | | [默认值](./date#%E9%BB%98%E8%AE%A4%E5%80%BC) |
|
|
| format | `string` | `X` | 月份选择器值格式，更多格式类型请参考 [moment](http://momentjs.com/) |
|
|
| inputFormat | `string` | `YYYY-MM` | 月份选择器显示格式，即时间戳格式，更多格式类型请参考 [moment](http://momentjs.com/) |
|
|
| placeholder | `string` | `"请选择月份"` | 占位文本 |
|
|
| clearable | `boolean` | `true` | 是否可清除 |
|
|
|
|
## 事件表
|
|
|
|
当前组件会对外派发以下事件，可以通过`onEvent`来监听这些事件，并通过`actions`来配置执行的动作，在`actions`中可以通过`event.data.xxx`事件参数变量来获取事件产生的数据，详细请查看[事件动作](../../docs/concepts/event-action)。
|
|
|
|
| 事件名称 | 事件参数 | 说明 |
|
|
| -------- | --------------------------------- | -------------------------------- |
|
|
| change | `event.data.value: string` 时间值 | 时间值变化时触发 |
|
|
| focus | `event.data.value: string` 时间值 | 输入框获取焦点(非内嵌模式)时触发 |
|
|
| blur | `event.data.value: string` 时间值 | 输入框失去焦点(非内嵌模式)时触发 |
|
|
|
|
## 动作表
|
|
|
|
当前组件对外暴露以下特性动作，其他组件可以通过指定`actionType: 动作名称`、`componentId: 该组件id`来触发这些动作，动作配置可以通过`args: {动作配置项名称: xxx}`来配置具体的参数，详细请查看[事件动作](../../docs/concepts/event-action#触发其他组件的动作)。
|
|
|
|
| 动作名称 | 动作配置 | 说明 |
|
|
| -------- | ---------------------------- | ------------------------------------------------------ |
|
|
| clear | - | 清空 |
|
|
| reset | - | 将值重置为`resetValue`，若没有配置`resetValue`，则清空 |
|
|
| setValue | `value: string` 更新的时间值 | 更新数据，依赖格式`format`，例如：'1646064000' |
|