mirror of
https://gitee.com/baidu/amis.git
synced 2024-12-15 17:31:18 +08:00
86 lines
2.4 KiB
Markdown
Executable File
86 lines
2.4 KiB
Markdown
Executable File
---
|
|
title: City 城市选择器
|
|
description:
|
|
type: 0
|
|
group: null
|
|
menuName: City
|
|
icon:
|
|
order: 10
|
|
---
|
|
城市选择器，可用于让用户输入城市。
|
|
|
|
## 基本用法
|
|
|
|
```schema:height="400" scope="body"
|
|
{
|
|
"type": "form",
|
|
"debug": true,
|
|
"api": "https://houtai.baidu.com/api/mock2/form/saveForm",
|
|
"controls": [
|
|
{
|
|
"name": "city",
|
|
"type": "city",
|
|
"label": "城市"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
观察数据域中表单项的值，存储的是位置邮编。
|
|
|
|
## 配置选择级别
|
|
|
|
可以通过设置 `allowDistrict` 和 `allowCity` 设置用户选择级别，例如只选择省份：
|
|
|
|
```schema:height="400" scope="body"
|
|
{
|
|
"type": "form",
|
|
"debug": true,
|
|
"api": "https://houtai.baidu.com/api/mock2/form/saveForm",
|
|
"controls": [
|
|
{
|
|
"name": "city",
|
|
"type": "city",
|
|
"label": "城市",
|
|
"allowDistrict": false,
|
|
"allowCity": false
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## 获取更多选项信息
|
|
|
|
表单项值默认格式是编码（即 `code`），如果你想要详细点的信息，可以把 `extractValue` 设置成 `false`。
|
|
|
|
```schema:height="400" scope="body"
|
|
{
|
|
"type": "form",
|
|
"debug": true,
|
|
"api": "https://houtai.baidu.com/api/mock2/form/saveForm",
|
|
"controls": [
|
|
{
|
|
"name": "city",
|
|
"type": "city",
|
|
"label": "城市",
|
|
"extractValue": false
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## 属性表
|
|
|
|
当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置
|
|
|
|
| 属性名 | 类型 | 默认值 | 说明 |
|
|
| ------------- | --------- | ------ | --------------------------------------------------------------------------------------------------------------------- |
|
|
| allowCity | `boolean` | `true` | 允许选择城市 |
|
|
| allowDistrict | `boolean` | `true` | 允许选择区域 |
|
|
| extractValue | `boolean` | `true` | 默认 `true` 是否抽取值，如果设置成 `false` 值格式会变成对象，包含 `code`、`province`、`city` 和 `district` 文字信息。 |
|
|
|
|
|
|
|
|
|
|
|