229 lines
9.6 KiB
Markdown
229 lines
9.6 KiB
Markdown
|
# custom-tree-select 使用指南
|
|||
|
|
|
|||
|
|
找工作中…，大佬们有内推加群联系我
|
|||
|
|
|
|||
|
|
**提示：** 使用该插件前确保你已经导入 `uni-popup` `uni-icons` `uni-easyinput` 插件。
|
|||
|
|
|
|||
|
|
当前插件主要作为表单中选择器来使用，如果只是作为弹窗会出现数据状态无法重置，此时推荐使用 [`custom-tree-popup`](https://ext.dcloud.net.cn/plugin?name=custom-tree-popup) 组件。
|
|||
|
|
|
|||
|
|
**如果在微信小程序中使用，在 `main.js` 文件中添加以下代码,2023/05/04 之前安装插件或者本地插件版本 `<=3.7.1` 需要添加**
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
// #ifdef MP-WEIXIN
|
|||
|
|
Vue.prototype.$bus = new Vue()
|
|||
|
|
// #endif
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**有问题可以加 QQ 群：297080738**
|
|||
|
|
|
|||
|
|
## 优势
|
|||
|
|
|
|||
|
|
💪：基于 `uni-popup`、 `uni-icons`、 `uni-easyinput` 插件进行开发，默认样式与 `uni-easyinput` 样式对标。
|
|||
|
|
|
|||
|
|
⚡：全面支持懒加载应对大量数据。
|
|||
|
|
|
|||
|
|
🚀：v-model 绑定数据、数据回显、移除选项。
|
|||
|
|
|
|||
|
|
⚙ ：提供更多配置项。
|
|||
|
|
|
|||
|
|
📦：开箱即用。
|
|||
|
|
|
|||
|
|
## Props
|
|||
|
|
|
|||
|
|
| 属性名 | 类型 | 默认值 | 说明 | 版本要求 |
|
|||
|
|
| :-------------------: | :---------: | :-----------------------------: | :----------------------------------------------------------: | --------- |
|
|||
|
|
| canSelectAll | Boolean | false | 开启一键全选功能 | |
|
|||
|
|
| contentHeight | String | '500px' \| 视窗高度的 75%的像素 | 弹出内选择器容器高度，为解决搜索时搜索框被顶出屏幕，监听输入框 focus 事件 动态修改弹窗内选择器容器高度 | |
|
|||
|
|
| clearResetSearch | Boolean | false | 设置为 `true` 并且搜索之后，点击输入框清除按钮，会清空搜索内容并且会直接重置整个弹窗内树形选择器内容，默认情况下只有清除之后再次进行查询才会重置选择器 | |
|
|||
|
|
| animation | Boolean | ture | 是否开启弹窗动画 | |
|
|||
|
|
| is-mask-click | Boolean | true | 点击遮罩关闭弹窗 | |
|
|||
|
|
| mask-background-color | String | rgba(0,0,0,0.4) | 蒙版颜色，建议使用 rgba 颜色值 | |
|
|||
|
|
| background-color | String | none | 主窗口背景色 | |
|
|||
|
|
| safe-area | Boolean | true | 是否适配底部安全区 | |
|
|||
|
|
| **choseParent** | **Boolean** | **true** | **父节点是否可选** | |
|
|||
|
|
| **linkage** | **Boolean** | **false** | **父子节点是否联动** | |
|
|||
|
|
| placeholder | String | 请选择 | 空状态信息提示、弹窗标题 | |
|
|||
|
|
| confirmText | String | 完成 | 确定按钮文字 | |
|
|||
|
|
| confirmTextColor | String | #007aff | 确定按钮文字颜色 | |
|
|||
|
|
| listData | Array | - | 展示的数据 | |
|
|||
|
|
| **dataLabel** | **String** | **name** | **listData 中对应数据的 label** | |
|
|||
|
|
| **dataValue** | **String** | **id** | **listData 中对应数据的 value** | |
|
|||
|
|
| **dataChildren** | **String** | **children** | **listData 中对应数据的 children** | |
|
|||
|
|
| clearable | Boolean | false | 是否显示清除按钮，点击清除所有已选项 | |
|
|||
|
|
| **mutiple** | **Boolean** | **false** | **是否可以多选** | |
|
|||
|
|
| **disabled** | **Boolean** | **false** | **是否允许修改** | |
|
|||
|
|
| disabledList | Array | [] | 设置某些选项为不可选，数组元素为数据 dataValue 对应的值，也可以操作数据 disabled 属性实现 | |
|
|||
|
|
| search | Boolean | false | 是否可以搜索（常用于数据较多的情况） | |
|
|||
|
|
| showChildren | Boolean | false | 默认展开（数据内部 showChildren 属性优先级更高，可以设置全局收起，单独展开某一条数据） | |
|
|||
|
|
| border | Boolean | false | 显示引导线 | |
|
|||
|
|
| pathMode | Boolean | false | 路径模式，开启后选择框内展示选项所在层级的完整信息如：`城市/街道/小区` | >= 3.8.2 |
|
|||
|
|
| pathHyphen | String | / | 路径模式下连字符 | >= 3.8.2 |
|
|||
|
|
| lazyLoadChildren | Boolean | false | 是否允许动态加载获取子节点 | >= 3.8.4 |
|
|||
|
|
| load | Function | (node) => Promise<void> | 动态加载函数，具体用法见下方示例 | >= 3.8.4 |
|
|||
|
|
| **v-model/value** | **Array** | **[ ]** | **已选择的值，通过 v-model 进行绑定，例如：v-model="formData.selectedList"** (根据你绑定数据的类型自动返回相同类型的数据，String 类型通过 `,` 进行分隔。>=4.0.0 版本不在支持字符串类型传参，修改为数组类型) | >= 4.0.0 |
|
|||
|
|
|
|||
|
|
## listdata 特有属性
|
|||
|
|
|
|||
|
|
| 名称 | 类型 | 默认值 | 说明 |
|
|||
|
|
| ------------ | ------- | ------ | ------------------ |
|
|||
|
|
| disabled | Boolean | false | 选项是否可选 |
|
|||
|
|
| visible | Boolean | true | 选项是否展示 |
|
|||
|
|
| showChildren | Boolean | true | 选项是否展示子节点 |
|
|||
|
|
|
|||
|
|
## Events
|
|||
|
|
|
|||
|
|
| 事件名称 | 说明 | 返回值 |
|
|||
|
|
| ------------ | ------------------------ | -------------------------------------- |
|
|||
|
|
| change | 弹窗组件状态发生变化触发 | e={show: true ｜ false, type:当前模式} |
|
|||
|
|
| maskClick | 点击遮罩层触发 | |
|
|||
|
|
| input | 选中数据或取消选中时触发 | 以数组形式返回已选择数据 |
|
|||
|
|
| selectChange | 选中数据或取消选中时触发 | 以数组形式返回已选择数据完整信息 |
|
|||
|
|
| removeSelect | 选择框移除选项时触发 | 返回对应数据的完整信息 |
|
|||
|
|
|
|||
|
|
## 基础使用示例
|
|||
|
|
|
|||
|
|
```vue
|
|||
|
|
<template>
|
|||
|
|
<!--/pages/index/index-->
|
|||
|
|
<custom-tree-select :listData="listData" v-model="formData.selectedArr" />
|
|||
|
|
</template>
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
export default {
|
|||
|
|
data() {
|
|||
|
|
return {
|
|||
|
|
formData: {
|
|||
|
|
selectedArr: [],
|
|||
|
|
},
|
|||
|
|
listData: [
|
|||
|
|
{
|
|||
|
|
id: 1,
|
|||
|
|
name: '城市1',
|
|||
|
|
children: [
|
|||
|
|
{
|
|||
|
|
id: 3,
|
|||
|
|
name: '街道1',
|
|||
|
|
children: [
|
|||
|
|
{
|
|||
|
|
id: 4,
|
|||
|
|
name: '小区1'
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
},
|
|||
|
|
{
|
|||
|
|
id: 2,
|
|||
|
|
name: '城市2',
|
|||
|
|
children: [
|
|||
|
|
{
|
|||
|
|
id: 6,
|
|||
|
|
name: '街道2'
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</script>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 禁用某些选项，或隐藏某些选项
|
|||
|
|
|
|||
|
|
```vue
|
|||
|
|
<template>
|
|||
|
|
<!--/pages/index/index-->
|
|||
|
|
<custom-tree-select
|
|||
|
|
mutiple
|
|||
|
|
linkage
|
|||
|
|
clearable
|
|||
|
|
search
|
|||
|
|
dataLabel="text"
|
|||
|
|
dataValue="value"
|
|||
|
|
:listData="listData"
|
|||
|
|
:disabledList="[6]"
|
|||
|
|
v-model="formData.selected"
|
|||
|
|
></custom-tree-select>
|
|||
|
|
</template>
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
export default {
|
|||
|
|
data() {
|
|||
|
|
return {
|
|||
|
|
formData: {
|
|||
|
|
selected: []
|
|||
|
|
},
|
|||
|
|
listData: [
|
|||
|
|
{
|
|||
|
|
value: 1,
|
|||
|
|
text: '城市1',
|
|||
|
|
children: [
|
|||
|
|
{
|
|||
|
|
value: 3,
|
|||
|
|
text: '街道1',
|
|||
|
|
disabled: true
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
},
|
|||
|
|
{
|
|||
|
|
value: 2,
|
|||
|
|
text: '城市2',
|
|||
|
|
children: [
|
|||
|
|
{
|
|||
|
|
value: 6,
|
|||
|
|
text: '街道2'
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
},
|
|||
|
|
{
|
|||
|
|
value: 7,
|
|||
|
|
text: '城市3',
|
|||
|
|
visible: false
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</script>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 动态加载节点
|
|||
|
|
|
|||
|
|
```vue
|
|||
|
|
<custom-tree-select
|
|||
|
|
:listData="listData"
|
|||
|
|
:load="load"
|
|||
|
|
lazyLoadChildren
|
|||
|
|
pathMode
|
|||
|
|
v-model="selectedArr"
|
|||
|
|
/>
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
export default {
|
|||
|
|
data() {
|
|||
|
|
return {
|
|||
|
|
selectedArr: []
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
methods: {
|
|||
|
|
load(node) {
|
|||
|
|
return new Promise((resolve, reject) => {
|
|||
|
|
if (node) {
|
|||
|
|
setTimeout(() => {
|
|||
|
|
resolve([
|
|||
|
|
{
|
|||
|
|
value: '128047129041',
|
|||
|
|
text: '测试异步加载'
|
|||
|
|
}
|
|||
|
|
])
|
|||
|
|
}, 2000)
|
|||
|
|
}
|
|||
|
|
})
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</script>
|
|||
|
|
```
|
|||
|
|
|