uniapp lb-picker选择器

插件市场里面的 picker 选择器不满足自己的需求,所以自己写了一个简单的 picker 选择器,可扩展、可自定义,一般满足日常需要。
Github:点击前往
插件市场:点击前往
H5 Demo:点击预览

如果问题最好去 github 反馈,插件市场评论区留下五星好评即可, 点我去反馈
最好提供一下使用的什么端,数据结构及大概的代码,我好复现找问题,不要直接提怎么xxx报错了等没意义的问题,神仙也不知道你为啥报错了。

由于之前cancel拼写失误,写成了canclev1.08现已修正,如果之前版本有使用cancel事件的,更新后请及时修正。

兼容性

App + Nvue + H5 + 各平台小程序(快应用及 360 未测试)

功能

  • 单选
  • 多级联动,非多级联动,理论支持任意级数
  • 省市区选择,基于多级联动
  • 日期选择器,年月日时分秒可自由组合选择(引入了dayjs方便处理日期)
  • 自定义选择器头部确定取消按钮颜色及插槽支持
  • 选择器可视区自定义滚动个数
  • 自定义数据字段,满足不同人的需求
  • 自定义选择器样式
  • formatter 格式化自定义显示
  • 单选及非联动选择支持扁平化的简单数据,如下形式:
// 单选列表
list1: ['选项1', '选项2', '选项2'],
// 非联动选择列表
list2: [
  ['选项1', '选项2', '选项3'],
  ['选项11', '选项22', '选项33'],
  ['选项111', '选项222', '选项333']
]

引入插件

单独引入,在需要使用的页面上 import 引入即可

<template>
  <view>
    <lb-picker></lb-picker>
  </view>
</template>

<script>
  import LbPicker from '@/components/lb-picker'
  export default {
    components: {
      LbPicker
    }
  }
</script>

全局引入,main.js中 import 引入并注册即可全局使用

import LbPicker from '@/components/lb-picker'
Vue.component("lb-picker", LbPicker)

easycom 引入(推荐使用此方式)

pages.json加上如下配置:

"easycom": {
  "autoscan": true,
  "custom": {
    "lb-picker": "@/components/lb-picker/index.vue"
  }
}

npm 安装引入:

npm install uni-lb-picker
import LbPicker from 'uni-lb-picker'

选择器数据格式

单选

常规数据

list: [
  {
    label: '选项1',
    value: '1'
  },
  {
    label: '选项2',
    value: '2'
  }
]

扁平化简单数据

list: ['选项1', '选项2']

多级联动

list: [
  {
    label: '选项1',
    value: '1',
    children: [
      {
        label: '选项1-1',
        value: '1-1',
        children: [
          {
            label: '选项1-1-1',
            value: '1-1-1'
          }
        ]
      }
    ]
  }
]

非联动选择

常规数据

list: [
  [
    { label: '选项1', value: '1' },
    { label: '选项2', value: '2' },
    { label: '选项3', value: '3' }
  ],
  [
    { label: '选项11', value: '11' },
    { label: '选项22', value: '22' },
    { label: '选项33', value: '33' }
  ],
  [
    { label: '选项111', value: '111' },
    { label: '选项222', value: '222' },
    { label: '选项333', value: '333' }
  ]
]

扁平化简单数据

list: [
  ['选项1', '选项2', '选项3'],
  ['选项11', '选项22', '选项33'],
  ['选项111', '选项222', '选项333']
]

调用显示选择器

通过ref形式手动调用show方法显示,隐藏同理调用hide

<lb-picker ref="picker"></lb-picker>
this.$refs.picker.show() // 显示
this.$refs.picker.hide() // 隐藏

v1.1.3新增,将需要点击的元素包裹在lb-picker中即可。

<lb-picker>
  <button>点我直接打开选择器</button>
</lb-picker>

绑定值及设置默认值

支持 vue 中v-model写法绑定值,无需自己维护选中值的索引。

<lb-picker v-model="value1"></lb-picker>
<lb-picker v-model="value2"></lb-picker>
<lb-picker v-model="value3"></lb-picker>

data () {
  return {
    value1: '', // 单选
    value2: [], // 多列联动选择
    value2: '2021-01-05', // 日期,设置一个具体的日期,留空则默认选中当前日期
  }
}

多个选择器

通过设置不同的ref,然后调用即可

<lb-picker ref="picker1"></lb-picker>
<lb-picker ref="picker2"></lb-picker>

this.$refs.picker1.show() // picker1显示
this.$refs.picker2.show() // picker2显示

省市区选择

省市区选择是基于多列联动选择,数据来源:https://github.com/modood/Administrative-divisions-of-China
省市区文件位于/pages/demos/area-data-min.js,自行引入即可,可参考demo3省市区选择
也可使用自己已有的省市区数据,如果数据字段不一样,也可以自定义,参考下方自定义数据字段。

自定义数据字段

为了满足不同人的需求,插件支持自定义数据字段名称, 插件默认的数据字段如下形式:

list: [
  {
    label: '选择1',
    value: 1,
    children: []
  },
  {
    label: '选择1',
    value: 1,
    children: []
  }
]

如果你的数据字段和上面不一样,如下形式:

list: [
  {
    text: '选择1',
    id: 1,
    child: []
  },
  {
    text: '选择1',
    id: 1,
    child: []
  }
]

通过设置参数中的props即可,如下所示:

<lb-picker :props="myProps"></lb-picker>

data () {
  return {
    myProps: {
      label: 'text',
      value: 'id',
      children: 'child'
    }
  }
}

插槽使用

选择器支持一些可自定义化的插槽,如选择器的取消和确定文字按钮,如果需要对其自定义处理的话,比如加个 icon 图标之类的,可使用插槽,使用方法如下:

<lb-picker>
  <view slot="cancel-text">我是自定义取消</view>
  <view slot="confirm-text">我是自定义确定</view>
</lb-picker>

也可参考示例中的demo5,自定义插槽元素样式交给开发者自由调整,插槽仅提供预留位置。

其他插槽见下。

参数及事件

Props

通用 Props

参数说明类型可选值默认值
value/v-model绑定值,联动选择为 Array 类型String/Number/Array日期类型为当前日期
mode选择器类型Stringselector 单选/multiSelector 多级联动/unlinkedSelector 多级非联动/dateSelector 日期选择(v1.1.9 新增)selector
cancel-text取消文字String取消
cancel-color取消文字颜色String#999
confirm-text确定文字String确定
confirm-color确定文字颜色String#007aff
empty-text(v1.0.7 新增)选择器列表为空的时候显示的文字String暂无数据
empty-color(v1.0.7 新增)暂无数据文字颜色String#999
column-num可视滚动区域内滚动个数,最好设置奇数值Number5
radius选择器顶部圆角,支持 rpx,如 radius=”10rpx”String
column-style(v1.1.6 重新新增)选择器默认样式,仅nvue支持,其他端见下选择器自定义样式说明Object
active-column-style(v1.1.6 重新新增)选择器选中样式,仅nvue支持,其他端见下选择器自定义样式说明Object
loading选择器是否显示加载中,可使用 loading 插槽自定义加载效果Boolean
mask-color遮罩层颜色Stringrgba(0, 0, 0, 0.4)
show-mask(v1.1.0 新增)是否显示遮罩层Booleantrue/falsetrue
close-on-click-mask点击遮罩层是否关闭选择器Booleantrue/falsetrue
change-on-init(v1.0.7 已弃用)初始化时是否触发 change 事件Booleantrue/false
dataset(v1.0.7 新增)可以向组件中传递任意的自定义的数据(对象形式数据),如:dataset="{name:'test'}",在confirmchange事件中可以取到Object
show-header(v1.0.8 新增)是否显示选择器头部Booleantrue
inline(v1.0.8 新增)inline 模式,开启后默认显示选择器,无需点击弹出,可以配合show-header一起使用Boolean
z-index(v1.0.9 新增)选择器层级,遮罩层默认-1Number999
safe-area-inset-bottom(v1.1.4 新增)是否留出底部安全距离(nvue 无效)Booleantrue/falsetrue
disabled(v1.1.4 新增)是否禁用选择器,禁用后无法弹出选择器Boolean
align(v1.1.6 新增)选择器中文字对齐方式,默认居中Stringleft/center/rightcenter
press-enable(v1.1.6 新增)是否开启长按选择器数据showtoast弹出label提示,部分情况下选择器数据文字过长会显示省略号,如需查看完整的文字内容,可开启此选项,长按后会showtoast弹出完整的文字内容,默认不开启(支付宝小程序暂不支持详情Boolean
press-time(v1.1.6 新增)长按触发时间,单位毫秒 msNumber500
formatter(v1.1.7 新增)格式化自定义选择器文字内容,Function类型,return一个字符串(日期选择器百度、支付宝、头条小程序不支持,其他选择器仅app nvue h5支持),item当前项信息,rowIndex当前数据所在行数,columnIndex当前数据所在列数,写法参考demo14,日期选择器可参考demo16Function({ item, rowIndex, columnIndex })

单选、多级联动、非联动选择 Props

参数说明类型可选值默认值
list选择器数据(v1.0.7 单选及非联动多选支持扁平数据:[‘选项 1’, ‘选项 2’])Array
level多列联动层级,仅 mode 为 multiSelector 有效Number1
props自定义数据字段Object{label:’label’,value:’value’,children:’children’}

日期选择 Props

参数说明类型可选值默认值
display-format日期选择显示的颗粒格式,见下方displayFormat、format说明,可自由组合,如YYYY-MM-DD,显示的就是选择年月日重要说明:始终是以-为分隔符,始终是以-为分隔符, 始终是以-为分隔符StringYYYY-MM-DD
format选择器返回的日期格式,见下方displayFormat、format说明,如配置YYYY年MM月DD日选择器确定后返回显示的值为2021年01月05号或者YYYY-MM-DD返回的就是2021-01-05,可以自由组合,需要和display-format参数配合使用。StringYYYY-MM-DD
start-date开始日期,可精确到秒,如2018-08-08 08:08:08String
end-date结束日期,可精确到秒,如2021-08-08 08:08:08String
default-time-limit默认显示的日期选择范围,默认当前日期前 20 年和后 20 年,配置start-dateend-date后失效Number20
is-show-chinese是否显示日期选择器年月日时分秒中文文字,默认显示Booleantrue/falsetrue
ch-config显示的日期选择器年月日时分秒文字配置Object{year: ‘年’, month: ‘月’, day: ‘日’, hour: ‘时’, minute: ‘分’, second: ‘秒’}

displayFormat、format 说明

标识示例描述
YY18年,两位数
YYYY2018年,四位数
M1-12月,从 1 开始
MM01-12月,两位数字
D1-31
DD01-31日,两位数
H0-2324 小时
HH00-2324 小时,两位数
h1-1212 小时
hh01-1212 小时,两位数
m0-59分钟
mm00-59分钟,两位数
s0-59
ss00-59秒,两位数

方法

方法名说明参数返回值
show打开选择器
hide关闭选择器
getColumnsInfo(v1.1.0 新增)根据 value 获取选择器信息绑定值的valuechange confirm回调参数,如果传入的value获取不到信息则只返回一个含有dataset的对象,具体自行打印查看

getColumnsInfo注意事项:

  • 需要组件加载完成后调用才有效,即console.log(this.$refs.picker)打印有内容,否则会报错,可在onReady中进行调用。
  • 如果动态设置list后马上调用getColumnsInfo会无法取到相关信息,可以加个setTimeout解决,如下形式:
onReady () {
  this.list = [{ label: '测试', value: 1 }] // 动态设置一个list
  setTimeout(() => {
    const info = that.$refs.picker.getColumnsInfo(xx)
    console.log(info)
  }, 0)
}

Events

事件名称说明回调参数
show选择器打开时触发
hide选择器隐藏时触发
change选择器滚动时触发,此时不会改变绑定的值{ index, item, value, change } index触发滚动后新的索引,单选时是具体的索引值,多列联动选择时为数组。item触发滚动后新的的完整内容,包括labelvalue等,日期选择器则为日期相关内容,单选时为对象,多列选择时为数组对象。value触发滚动后新的 value 值,单列选择时为具体值,多列联动选择时为数组。change触发事件的类型,详情参考下面的 change 事件备注
confirm点击选择器确定时触发,此时会改变绑定的值同上change事件说明
cancel点击选择器取消时触发同上change事件说明

change 事件备注

如果绑定的值是空的,change触发后里面的内容都是列表的第一项。
change事件会在以下情况触发:

  • 初始化
  • 绑定值 value 变化
  • 选择器 list 列表变化
  • 滚动选择器

以上情况会在回调函数中都可以取到change变化的类型,对应上面的情况包括以下:

  • init
  • value
  • list
  • scroll

根据这些类型大家可以在change的时候按需处理自己的业务逻辑,init现在指挥在调用选择器弹出的时候触发。
下面的说明情况已失效,如需要在页面显示的时候根据value的值显示相应的中文,调用v1.10新增的方法getColumnsInfo,传入绑定的值即可获取到你想要的所有信息。
比如一种常见的情况,有默认值的时候需要显示默认值的文字,此时可以change事件中判断change的类型是否是init,如果是的话可以取事件回调中的item进行显示绑定值对应的文字信息。

handleChange (e) {
  if (e.change === 'init') {
    console.log(e.item.label) // 单选 选项1
    console.log(e.item.map(item => item.label).join('-')) // 多选 选项1-选项11
  }
}

插槽

插槽名说明
cancel-text选择器取消文字插槽
action-center选择器顶部中间插槽
confirm-text选择器确定文字插槽
loading选择器 loading 插槽
empty选择器 空数据 插槽
header-top选择器头部顶部插槽
header-bottom选择器头部底部插槽
picker-top选择器滚动部分顶部插槽
picker-bottom选择器滚动部分底部插槽

选择器自定义样式

nvue 专属写法,需要定义column-styleactive-column-style,写法如下:

<lb-picker
  :column-style="columnStyle"
  :active-column-style="activeColumnStyle"
></lb-picker>
data () {
  return {
    // 默认样式
    columnStyle: {
      color: '#f0ad4e'
    },
    // 选择样式
    activeColumnStyle: {
      color: '#007aff',
      fontWeight: 700
    }
  }
}

其他端写法,覆盖默认样式即可。

<style lang="scss" scoped>
/deep/ .lb-picker {
  .lb-picker-column-label {
    color: #f0ad4e;
  }
  .lb-picker-column-active {
    .lb-picker-column-label {
      color: #007aff;
      font-weight: 700;
    }
  }
}
</style>

完整代码可以参考demo9

获取选中值的文字

@confirm事件中可以拿到:

单选:

handleConfirm (e) {
  console.log(e.item.label) // 选项1
}

联动选择:

handleConfirm (e) {
  console.log(e.item.map(item => item.label).join('-')) // 选项1-选项11
}

Tips

微信小程序端,滚动时在 iOS 自带振动反馈,可在系统设置 -> 声音与触感 -> 系统触感反馈中关闭

其他

其他功能参考示例 Demo 代码。

暂无评论

发送评论编辑评论

|´・ω・)ノ
ヾ(≧∇≦*)ゝ
(☆ω☆)
(╯‵□′)╯︵┴─┴
 ̄﹃ ̄
(/ω\)
∠( ᐛ 」∠)_
(๑•̀ㅁ•́ฅ)
→_→
୧(๑•̀⌄•́๑)૭
٩(ˊᗜˋ*)و
(ノ°ο°)ノ
(´இ皿இ`)
⌇●﹏●⌇
(ฅ´ω`ฅ)
(╯°A°)╯︵○○○
φ( ̄∇ ̄o)
ヾ(´・ ・`。)ノ"
( ง ᵒ̌皿ᵒ̌)ง⁼³₌₃
(ó﹏ò。)
Σ(っ °Д °;)っ
( ,,´・ω・)ノ"(´っω・`。)
╮(╯▽╰)╭
o(*////▽////*)q
>﹏<
( ๑´•ω•) "(ㆆᴗㆆ)
😂
😀
😅
😊
🙂
🙃
😌
😍
😘
😜
😝
😏
😒
🙄
😳
😡
😔
😫
😱
😭
💩
👻
🙌
🖕
👍
👫
👬
👭
🌚
🌝
🙈
💊
😶
🙏
🍦
🍉
😣
Source: github.com/k4yt3x/flowerhd
颜文字
Emoji
小恐龙
花!
上一篇
下一篇