amis/docs/zh-CN/components/form/city.md
2021-01-19 10:20:09 +08:00

2.8 KiB
Executable File
Raw Blame History

title description type group menuName icon order
City 城市选择器 0 null City 10

城市选择器,方便输入城市,可以理解为自动配置了国内城市选项的 Select支持到县级别。

基本用法

{
    "type": "form",
    "debug": true,
    "api": "https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm",
    "controls": [
        {
            "name": "city",
            "type": "city",
            "label": "城市",
            "searchable": true
        }
    ]
}

观察数据域中表单项的值,存储的是位置邮编。

配置选择级别

可以通过设置 allowDistrictallowCity 设置用户选择级别,例如只选择省份:

{
    "type": "form",
    "debug": true,
    "api": "https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm",
    "controls": [
        {
            "name": "city",
            "type": "city",
            "label": "城市",
            "allowDistrict": false,
            "allowCity": false
        }
    ]
}

获取更多选项信息

表单项值默认格式是编码(即 code),如果你想要详细点的信息,可以把 extractValue 设置成 false

{
    "type": "form",
    "debug": true,
    "api": "https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm",
    "controls": [
        {
            "name": "city",
            "type": "city",
            "label": "城市",
            "extractValue": false
        }
    ]
}

属性表

当做选择器表单项使用时,除了支持 普通表单项属性表 中的配置以外,还支持下面一些配置

属性名 类型 默认值 说明
allowCity boolean true 允许选择城市
allowDistrict boolean true 允许选择区域
searchable boolean false 是否出搜索框
extractValue boolean true 默认 true 是否抽取值,如果设置成 false 值格式会变成对象,包含 codeprovincecitydistrict 文字信息。