InputCity 城市选择器
城市选择器,方便输入城市,可以理解为自动配置了国内城市选项的 Select,支持到县级别。
基本用法
```schema: scope=”body” { “type”: “form”, “debug”: true, “api”: “/api/mock2/form/saveForm”, “body”: [ { “name”: “city”, “type”: “input-city”, “label”: “城市”, “searchable”: true } ] }
观察数据域中表单项的值,存储的是位置邮编。
## 配置选择级别
可以通过设置 `allowDistrict` 和 `allowCity` 设置用户选择级别,例如只选择省份:
```schema: scope="body"
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"name": "city",
"type": "input-city",
"label": "城市",
"allowDistrict": false,
"allowCity": false
}
]
}
获取更多选项信息
表单项值默认格式是编码(即 code
),如果你想要详细点的信息,可以把 extractValue
设置成 false
。
schema: scope="body"
{
"type": "form",
"debug": true,
"api": "/api/mock2/form/saveForm",
"body": [
{
"name": "city",
"type": "input-city",
"label": "城市",
"extractValue": false
}
]
}
属性表
当做选择器表单项使用时,除了支持 普通表单项属性表 中的配置以外,还支持下面一些配置
属性名 | 类型 | 默认值 | 说明 |
---|---|---|---|
allowCity | boolean |
true |
允许选择城市 |
allowDistrict | boolean |
true |
允许选择区域 |
searchable | boolean |
false |
是否出搜索框 |
extractValue | boolean |
true |
默认 true 是否抽取值,如果设置成 false 值格式会变成对象,包含 code 、province 、city 和 district 文字信息。 |
事件表
当前组件会对外派发以下事件,可以通过onEvent
来监听这些事件,并通过actions
来配置执行的动作,在actions
中可以通过event.data.xxx
事件参数变量来获取事件产生的数据,详细请查看事件动作。
事件名称 | 事件参数 | 说明 | |
---|---|---|---|
change | `event.data.value: number \ | string` 选中值 | 选中值变化时触发 |
动作表
当前组件对外暴露以下特性动作,其他组件可以通过指定actionType: 动作名称
、componentId: 该组件id
来触发这些动作,动作配置可以通过args: {动作配置项名称: xxx}
来配置具体的参数,详细请查看事件动作。
动作名称 | 动作配置 | 说明 | |
---|---|---|---|
clear | - | 清空 | |
reset | - | 将值重置为resetValue ,若没有配置resetValue ,则清空 |
|
setValue | `value: string \ | number` 更新的值 | 更新数据 |