You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
489 lines
29 KiB
489 lines
29 KiB
7 months ago
|
<p align="center">
|
||
|
<a href="https://github.com/liub1934/uni-lb-picker">
|
||
|
<img src="https://img.shields.io/github/stars/liub1934/uni-lb-picker">
|
||
|
</a>
|
||
|
<a href="https://github.com/liub1934/uni-lb-picker/fork">
|
||
|
<img src="https://img.shields.io/github/forks/liub1934/uni-lb-picker">
|
||
|
</a>
|
||
|
<a href="https://github.com/liub1934/uni-lb-picker/issues">
|
||
|
<img src="https://img.shields.io/github/issues/liub1934/uni-lb-picker">
|
||
|
</a>
|
||
|
<a href="https://www.npmjs.com/package/uni-lb-picker">
|
||
|
<img src="https://img.shields.io/npm/v/uni-lb-picker">
|
||
|
</a>
|
||
|
<a href="https://npmcharts.com/compare/uni-lb-picker?minimal=true">
|
||
|
<img src="https://img.shields.io/npm/dm/uni-lb-picker">
|
||
|
</a>
|
||
|
<a href="https://standardjs.com">
|
||
|
<img src="https://img.shields.io/badge/code%20style-standard-brightgreen">
|
||
|
</a>
|
||
|
<a href="https://github.com/liub1934/uni-lb-picker/blob/master/LICENSE">
|
||
|
<img src="https://img.shields.io/github/license/liub1934/uni-lb-picker">
|
||
|
</a>
|
||
|
</p>
|
||
|
|
||
|
插件市场里面的 picker 选择器不满足自己的需求,所以自己写了一个简单的 picker 选择器,可扩展、可自定义,一般满足日常需要。
|
||
|
Github:[uni-lb-picker](https://github.com/liub1934/uni-lb-picker)
|
||
|
插件市场:[uni-lb-picker](https://ext.dcloud.net.cn/plugin?id=1111)
|
||
|
H5 Demo:[点击预览](https://github.liubing.me/uni-lb-picker)
|
||
|
|
||
|
> 如果问题最好去 github 反馈,插件市场评论区留下五星好评即可,[点我去反馈](https://github.com/liub1934/uni-lb-picker/issues/new)
|
||
|
|
||
|
> **由于之前`cancel`拼写失误,写成了`cancle`,`v1.08`现已修正,如果之前版本有使用`cancel`事件的,更新后请及时修正。**
|
||
|
|
||
|
## 兼容性
|
||
|
|
||
|
App + Nvue + H5 + 各平台小程序(快应用及 360 未测试)
|
||
|
|
||
|
## 功能
|
||
|
|
||
|
1、单选
|
||
|
2、多级联动,非多级联动,理论支持任意级数
|
||
|
3、省市区选择,基于多级联动
|
||
|
4、自定义选择器头部确定取消按钮颜色及插槽支持
|
||
|
5、选择器可视区自定义滚动个数
|
||
|
6、自定义数据字段,满足不同人的需求
|
||
|
7、自定义选择器样式
|
||
|
8、formatter 格式化自定义显示
|
||
|
9、单选及非联动选择支持扁平化的简单数据,如下形式:
|
||
|
|
||
|
```javascript
|
||
|
// 单选列表
|
||
|
list1: ['选项1', '选项2', '选项2'],
|
||
|
// 非联动选择列表
|
||
|
list2: [
|
||
|
['选项1', '选项2', '选项3'],
|
||
|
['选项11', '选项22', '选项33'],
|
||
|
['选项111', '选项222', '选项333']
|
||
|
]
|
||
|
```
|
||
|
|
||
|
## 引入插件
|
||
|
|
||
|
单独引入,在需要使用的页面上 import 引入即可
|
||
|
|
||
|
```html
|
||
|
<template>
|
||
|
<view>
|
||
|
<lb-picker></lb-picker>
|
||
|
</view>
|
||
|
</template>
|
||
|
|
||
|
<script>
|
||
|
import LbPicker from '@/components/lb-picker'
|
||
|
export default {
|
||
|
components: {
|
||
|
LbPicker
|
||
|
}
|
||
|
}
|
||
|
</script>
|
||
|
```
|
||
|
|
||
|
全局引入,`main.js`中 import 引入并注册即可全局使用
|
||
|
|
||
|
```jsvascript
|
||
|
import LbPicker from '@/components/lb-picker'
|
||
|
Vue.component("lb-picker", LbPicker)
|
||
|
```
|
||
|
|
||
|
easycom 引入
|
||
|
|
||
|
`pages.json`加上如下配置:
|
||
|
|
||
|
```json
|
||
|
"easycom": {
|
||
|
"autoscan": true,
|
||
|
"custom": {
|
||
|
"lb-picker": "@/components/lb-picker/index.vue"
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
npm 安装引入:
|
||
|
|
||
|
```shell
|
||
|
npm install uni-lb-picker
|
||
|
```
|
||
|
|
||
|
```jsvascript
|
||
|
import LbPicker from 'uni-lb-picker'
|
||
|
```
|
||
|
|
||
|
## 选择器数据格式
|
||
|
|
||
|
### 单选
|
||
|
|
||
|
常规数据
|
||
|
|
||
|
```javascript
|
||
|
list: [
|
||
|
{
|
||
|
label: '选项1',
|
||
|
value: '1'
|
||
|
},
|
||
|
{
|
||
|
label: '选项2',
|
||
|
value: '2'
|
||
|
}
|
||
|
]
|
||
|
```
|
||
|
|
||
|
扁平化简单数据
|
||
|
|
||
|
```javascript
|
||
|
list: ['选项1', '选项2']
|
||
|
```
|
||
|
|
||
|
### 多级联动
|
||
|
|
||
|
```javascript
|
||
|
list: [
|
||
|
{
|
||
|
label: '选项1',
|
||
|
value: '1',
|
||
|
children: [
|
||
|
{
|
||
|
label: '选项1-1',
|
||
|
value: '1-1',
|
||
|
children: [
|
||
|
{
|
||
|
label: '选项1-1-1',
|
||
|
value: '1-1-1'
|
||
|
}
|
||
|
]
|
||
|
}
|
||
|
]
|
||
|
}
|
||
|
]
|
||
|
```
|
||
|
|
||
|
### 非联动选择
|
||
|
|
||
|
常规数据
|
||
|
|
||
|
```javascript
|
||
|
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' }
|
||
|
]
|
||
|
]
|
||
|
```
|
||
|
|
||
|
扁平化简单数据
|
||
|
|
||
|
```javascript
|
||
|
list: [
|
||
|
['选项1', '选项2', '选项3'],
|
||
|
['选项11', '选项22', '选项33'],
|
||
|
['选项111', '选项222', '选项333']
|
||
|
]
|
||
|
```
|
||
|
|
||
|
## 调用显示选择器
|
||
|
|
||
|
通过`ref`形式手动调用`show`方法显示,隐藏同理调用`hide`
|
||
|
|
||
|
```html
|
||
|
<lb-picker ref="picker"></lb-picker>
|
||
|
```
|
||
|
|
||
|
```javascript
|
||
|
this.$refs.picker.show() // 显示
|
||
|
this.$refs.picker.hide() // 隐藏
|
||
|
```
|
||
|
|
||
|
`v1.1.3`新增,将需要点击的元素包裹在`lb-picker`中即可。
|
||
|
|
||
|
```html
|
||
|
<lb-picker>
|
||
|
<button>点我直接打开选择器</button>
|
||
|
</lb-picker>
|
||
|
```
|
||
|
|
||
|
## 绑定值及设置默认值
|
||
|
|
||
|
支持 vue 中`v-model`写法绑定值,无需自己维护选中值的索引。
|
||
|
|
||
|
```javascript
|
||
|
<lb-picker v-model="value1"></lb-picker>
|
||
|
<lb-picker v-model="value2"></lb-picker>
|
||
|
|
||
|
data () {
|
||
|
return {
|
||
|
value1: '' // 单选
|
||
|
value2: [] // 多列联动选择
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
## 多个选择器
|
||
|
|
||
|
通过设置不同的`ref`,然后调用即可
|
||
|
|
||
|
```javascript
|
||
|
<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](https://github.com/modood/Administrative-divisions-of-China),
|
||
|
省市区文件位于`/pages/demos/area-data-min.js`,自行引入即可,可参考`demo3省市区选择`,
|
||
|
也可使用自己已有的省市区数据,如果数据字段不一样,也可以自定义,参考下方自定义数据字段。
|
||
|
|
||
|
## 自定义数据字段
|
||
|
|
||
|
为了满足不同人的需求,插件支持自定义数据字段名称, 插件默认的数据字段如下形式:
|
||
|
|
||
|
```javascript
|
||
|
list: [
|
||
|
{
|
||
|
label: '选择1',
|
||
|
value: 1,
|
||
|
children: []
|
||
|
},
|
||
|
{
|
||
|
label: '选择1',
|
||
|
value: 1,
|
||
|
children: []
|
||
|
}
|
||
|
]
|
||
|
```
|
||
|
|
||
|
如果你的数据字段和上面不一样,如下形式:
|
||
|
|
||
|
```javascript
|
||
|
list: [
|
||
|
{
|
||
|
text: '选择1',
|
||
|
id: 1,
|
||
|
child: []
|
||
|
},
|
||
|
{
|
||
|
text: '选择1',
|
||
|
id: 1,
|
||
|
child: []
|
||
|
}
|
||
|
]
|
||
|
```
|
||
|
|
||
|
通过设置参数中的`props`即可,如下所示:
|
||
|
|
||
|
```javascript
|
||
|
<lb-picker :props="myProps"></lb-picker>
|
||
|
|
||
|
data () {
|
||
|
return {
|
||
|
myProps: {
|
||
|
label: 'text',
|
||
|
value: 'id',
|
||
|
children: 'child'
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
## 插槽使用
|
||
|
|
||
|
选择器支持一些可自定义化的插槽,如选择器的取消和确定文字按钮,如果需要对其自定义处理的话,比如加个 icon 图标之类的,可使用插槽,使用方法如下:
|
||
|
|
||
|
```html
|
||
|
<lb-picker>
|
||
|
<view slot="cancel-text">我是自定义取消</view>
|
||
|
<view slot="confirm-text">我是自定义确定</view>
|
||
|
</lb-picker>
|
||
|
```
|
||
|
|
||
|
也可参考示例中的`demo5`,自定义插槽元素样式交给开发者自由调整,插槽仅提供预留位置。
|
||
|
|
||
|
其他插槽见下。
|
||
|
|
||
|
## 参数及事件
|
||
|
|
||
|
### Props
|
||
|
|
||
|
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
||
|
| :--------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------- | :--------------------------------------------------------------- | :------------------------------------------------ |
|
||
|
| value/v-model | 绑定值,联动选择为 Array 类型 | String/Number/Array | - | - |
|
||
|
| mode | 选择器类型,支持单列,多列联动 | String | selector 单选/multiSelector 多级联动/unlinkedSelector 多级非联动 | selector |
|
||
|
| list | 选择器数据(v1.0.7 单选及非联动多选支持扁平数据:['选项 1', '选项 2']) | Array | - | - |
|
||
|
| level | 多列联动层级,仅 mode 为 multiSelector 有效 | Number | - | 1 |
|
||
|
| props | 自定义数据字段 | Object | - | {label:'label',value:'value',children:'children'} |
|
||
|
| 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 | 可视滚动区域内滚动个数,最好设置奇数值 | Number | - | 5 |
|
||
|
| 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 | 遮罩层颜色 | String | - | rgba(0, 0, 0, 0.4) |
|
||
|
| show-mask | `(v1.1.0 新增)`是否显示遮罩层 | Boolean | true/false | true |
|
||
|
| close-on-click-mask | 点击遮罩层是否关闭选择器 | Boolean | true/false | true |
|
||
|
| ~~change-on-init~~ | ~~(v1.0.7 已弃用)初始化时是否触发 change 事件~~ | Boolean | true/false | - |
|
||
|
| dataset | `(v1.0.7 新增)`可以向组件中传递任意的自定义的数据(对象形式数据),如`:dataset="{name:'test'}"`,在`confirm`或`change`事件中可以取到 | Object | - | - |
|
||
|
| show-header | `(v1.0.8 新增)`是否显示选择器头部 | Boolean | - | true |
|
||
|
| inline | `(v1.0.8 新增)`inline 模式,开启后默认显示选择器,无需点击弹出,可以配合`show-header`一起使用 | Boolean | - | - |
|
||
|
| z-index | `(v1.0.9 新增)`选择器层级,遮罩层默认-1 | Number | - | 999 |
|
||
|
| safe-area-inset-bottom | `(v1.1.4 新增)`是否留出底部安全距离(nvue 无效) | Boolean | true/false | true |
|
||
|
| disabled | `(v1.1.4 新增)`是否禁用选择器,禁用后无法弹出选择器 | Boolean | - | - |
|
||
|
| align | `(v1.1.6 新增)`选择器中文字对齐方式,默认居中 | String | left/center/right | center |
|
||
|
| press-enable | `(v1.1.6 新增)`是否开启长按选择器数据`showtoast`弹出`label`提示,部分情况下选择器数据文字过长会显示省略号,如需查看完整的文字内容,可开启此选项,长按后会`showtoast`弹出完整的文字内容,默认不开启(支付宝小程序暂不支持[详情](https://ask.dcloud.net.cn/question/106237)) | Boolean | - | - |
|
||
|
| press-time | `(v1.1.6 新增)`长按触发时间,单位毫秒 ms | Number | - | 500 |
|
||
|
| formatter | `(v1.1.7 新增)`格式化自定义选择器文字内容,`Function`类型,`return`一个字符串(仅`app` `nvue` `h5`支持),`item`当前项信息,`rowIndex`当前数据所在行数,`columnIndex`当前数据所在列数,写法参考[demo14](https://github.com/liub1934/uni-lb-picker/blob/master/pages/demos/demo14/demo14.vue#L206) | Function({ item, rowIndex, columnIndex }) | - | - |
|
||
|
|
||
|
### 方法
|
||
|
|
||
|
| 方法名 | 说明 | 参数 | 返回值 |
|
||
|
| :------------- | :------------------------------------- | :-------------- | :----------------------------------------------------------------------------------------------------------- |
|
||
|
| show | 打开选择器 | - | |
|
||
|
| hide | 关闭选择器 | - | |
|
||
|
| getColumnsInfo | (v1.1.0 新增)根据 value 获取选择器信息 | 绑定值的`value` | 同`change` `confirm`回调参数,如果传入的`value`获取不到信息则只返回一个含有`dataset`的对象,具体自行打印查看 |
|
||
|
|
||
|
### Events
|
||
|
|
||
|
| 事件名称 | 说明 | 回调参数 |
|
||
|
| :------- | :--------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
|
| show | 选择器打开时触发 | - |
|
||
|
| hide | 选择器隐藏时触发 | - |
|
||
|
| change | 选择器滚动时触发,此时不会改变绑定的值 | `{ index, item, value, change }` `index`触发滚动后新的索引,单选时是具体的索引值,多列联动选择时为数组。`item`触发滚动后新的的完整内容,包括`label`、`value`等,单选时为对象,多列选择时为数组对象。`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`进行显示绑定值对应的文字信息。~~
|
||
|
|
||
|
```javascript
|
||
|
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-style`和`active-column-style`,写法如下:
|
||
|
|
||
|
```html
|
||
|
<lb-picker
|
||
|
:column-style="columnStyle"
|
||
|
:active-column-style="activeColumnStyle"
|
||
|
></lb-picker>
|
||
|
```
|
||
|
|
||
|
```javascript
|
||
|
data () {
|
||
|
return {
|
||
|
// 默认样式
|
||
|
columnStyle: {
|
||
|
color: '#f0ad4e'
|
||
|
},
|
||
|
// 选择样式
|
||
|
activeColumnStyle: {
|
||
|
color: '#007aff',
|
||
|
fontWeight: 700
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
> 其他端写法,覆盖默认样式即可。
|
||
|
|
||
|
```css
|
||
|
<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`事件中可以拿到:
|
||
|
|
||
|
单选:
|
||
|
|
||
|
```javascript
|
||
|
handleConfirm (e) {
|
||
|
console.log(e.item.label) // 选项1
|
||
|
}
|
||
|
```
|
||
|
|
||
|
联动选择:
|
||
|
|
||
|
```javascript
|
||
|
handleConfirm (e) {
|
||
|
console.log(e.item.map(item => item.label).join('-')) // 选项1-选项11
|
||
|
}
|
||
|
```
|
||
|
|
||
|
## Tips
|
||
|
|
||
|
微信小程序端,滚动时在 iOS 自带振动反馈,可在系统设置 -> 声音与触感 -> 系统触感反馈中关闭
|
||
|
|
||
|
## 其他
|
||
|
|
||
|
其他功能参考示例 Demo 代码。
|