组件名:uni-data-picker

代码块: uDataPicker 关联组件:uni-data-pickerviewuni-load-more

点击下载&安装 (opens new window)

<uni-data-picker> 是一个选择类datacom组件 (opens new window)

支持单列、和多列级联选择。列数没有限制,如果屏幕显示不全,顶部tab区域会左右滚动。

候选数据支持一次性加载完毕,也支持懒加载,比如示例图中,选择了“北京”后,动态加载北京的区县数据。

<uni-data-picker> 组件尤其适用于地址选择、分类选择等选择类。

<uni-data-picker> 支持本地数据、云端静态数据(json),uniCloud云数据库数据。

<uni-data-picker> 可以通过JQL直连uniCloud云数据库,配套DB Schema (opens new window),可在schema2code中自动生成前端页面,还支持服务器端校验。

在uniCloud数据表中新建表“uni-id-address”和“opendb-city-china”,这2个表的schema自带foreignKey关联。在“uni-id-address”表的表结构页面使用schema2code生成前端页面,会自动生成地址管理的维护页面,自动从“opendb-city-china”表包含的中国所有省市区信息里选择地址。

# 介绍

注意事项

为了避免错误使用,给大家带来不好的开发体验,请在使用组件前仔细阅读下面的注意事项,可以帮你避免一些错误。

# 云端数据

<template>
  <view>
    <uni-data-picker placeholder="请选择地址" popup-title="请选择城市" collection="opendb-city-china" field="code as value, name as text" orderby="value asc" :step-searh="true" self-field="code" parent-field="parent_code"
 @change="onchange" @nodeclick="onnodeclick">
    </uni-data-picker>
  </view>
</template>
<script>
  export default {
    data() {
      return {
      }
    },
    methods: {
      onchange(e) {
        const value = e.detail.value
      },
      onnodeclick(node) {}
    }
  }
</script>

# 本地数据

<template>
  <view>
    <uni-data-picker :localdata="items" popup-title="请选择班级" @change="onchange" @nodeclick="onnodeclick"></uni-data-picker>
  </view>
</template>

<script>
  export default {
    data() {
      return {
        items: [{
          text: "一年级",
          value: "1-0",
          children: [
            {
              text: "1.1班",
              value: "1-1"
            },
            {
              text: "1.2班",
              value: "1-2"
            }
          ]
        },
        {
          text: "二年级",
          value: "2-0"
        },
        {
          text: "三年级",
          value: "3-0"
        }]
      }
    },
    methods: {
      onchange(e) {
        const value = e.detail.value
      },
      onnodeclick(node) {
      }
    }
  }
</script>

# 自定义 Solt

<uni-data-picker v-slot:default="{data, error, options}" popup-title="请选择所在地区">
  <view v-if="error" class="error">
    <text>{{error}}</text>
  </view>
  <view v-else-if="data.length" class="selected">
    <view v-for="(item,index) in data" :key="index" class="selected-item">
      <text>{{item.text}}</text>
    </view>
  </view>
  <view v-else>
    <text>请选择</text>
  </view>
</uni-data-picker>

注意事项 localdatacollection 同时配置时,localdata 优先

# API

# DataPicker Props

属性名 类型 可选值 默认值 说明
v-model String/ Number - - 绑定数据
spaceInfo Object - - 服务空间配置,详情 (opens new window)
localdata Array - - 数据,详情 (opens new window)
preload Boolean true/false false 预加载数据
readonly Boolean true/false false 是否禁用
clear-icon Boolean true/false true 是否显示清除按钮
ellipsis Boolean true/false true 是否隐藏 tab 标签过长的文本
step-searh Boolean true/false true 分步查询时,点击节点请求数据
step-search-url String - - 分步查询时,动态加载云端数据url格式,https://xxx.com/{parentValue}(当前版本暂不支持,下版支持)
self-field String - - 分步查询时当前字段名称
parent-field String - - 分步查询时父字段名称
collection String - - 表名。支持输入多个表名,用 , 分割
field String - - 查询字段,多个字段用 , 分割
where String - - 查询条件,内容较多,另见jql文档:详情 (opens new window)
orderby String - - 排序字段及正序倒叙设置
popup-title String 弹出层标题
map Object - {text:'text',value:'value'} 字段映射,将text/value映射到数据中的其他字段

注意

collection/where/orderby<unicloud-db> 的用法一致,详情 (opens new window)

# DataPicker Events

事件称名 类型 说明
@change EventHandle 选择完成时触发 {detail: {value}}
@nodeclick EventHandle 节点被点击时触发
@stepsearch EventHandle 动态加载节点数据前触发(当前版本暂不支持,下版支持)
@popupopened EventHandle 弹出层弹出时触发
@popupclosed EventHandle 弹出层关闭时触发

# DataPicker Methods

方法称名 说明 参数
show 打开弹出层 -
hide 关闭弹出层 -
clear 清除已选项 -

使用方法:

this.$refs.picker.show() // `picker` 为组件的 ref 名称

# DataPicker Slots

名称 说明
default 覆盖显示框内容

# 示例

注意

示例依赖了 uni-card uni-section uni-scss 等多个组件,直接拷贝示例代码将无法正常运行 。

请到 组件下载页面 (opens new window) ,在页面右侧选择 使用 HBuilderX导入示例项目 ,体验完整组件示例。

Template

Script

Style

<template>
	<view class="container">
		<uni-card is-full :is-shadow="false">
			<text class="uni-h6">标签组件多用于商品分类、重点内容显示等场景。</text>
		</uni-card>
		<uni-section title="本地数据" type="line" padding style="height: calc(100vh - 100px);">
			<uni-data-picker placeholder="请选择班级" popup-title="请选择所在地区" :localdata="dataTree" v-model="classes"
				@change="onchange" @nodeclick="onnodeclick" @popupopened="onpopupopened" @popupclosed="onpopupclosed">
			</uni-data-picker>
		</uni-section>
	</view>
</template>

完整示例演示 (opens new window)