1.2.8 • Published 4 years ago
enhance-multiple-cascader v1.2.8
基于iview的多选级联组件
description
enhance multiple cascader base on iview
usage
import
- 以ES Module的方式使用:
# install module
npm i southhill/enhance-multiple-cascader-iview -S
// 引入iview组件库,样式
// 引入iview.css
import iView from 'iview'
import 'iview/dist/styles/iview.css'
// 全局注册组件
import EnhanceMultipleCascader from 'enhance-multiple-cascader'
Vue.use(iView)
Vue.use(EnhanceMultipleCascader)
// 在组件内部使用
import { EnhanceMultipleCascader } from 'enhance-multiple-cascader'
export default {
// ...
components: { EnhanceMultipleCascader }
}
- 以AMD的方式使用:
<!-- 依赖引入:使用script标签引入vue.js,iview.js。使用link标签引入iview.css。-->
<script src="https://cdn.bootcss.com/vue/2.6.10/vue.common.dev.js"></script>
<link rel="stylesheet" type="text/css" href="http://unpkg.com/iview@3.5.1/dist/styles/iview.css">
<script src="https://cdn.bootcss.com/iview/3.5.1/iview.js"></script>
<script src="./dist/enhance-multiple-cascader.js" type="text/javascript"><script>
props explain
prop | type | default | explain |
---|---|---|---|
disabled | Boolean | false | 是否被禁用 |
value | Array | [] | 双向绑定使用的值 |
names | Array | [] | 该属性用来校验传入的value的标签是否与data中的数据保持一致,如果不一致,则清空组件的选中内容。 |
data | Array | [] | 待使用的级联数据 |
notFoundText | String | 没有数据可用 | 当没有找到数据时,显示的文本内容 |
propAlias | Object | 传递下来的data数据的属性的别名。有可能从服务端获取到的data树的属性名并不能符合当前使用中的属性名,所以做一次映射操作,以避免对服务端数据的处理,方便操作。 | |
onlyLeaf | Boolean | true | 仅仅只能选择叶子节点 |
uniqueFieldInLeaf | String | |叶子节点独有的字段,用来标识是否为叶子节点 | |
allowSelectByParentNode | Boolean | false | 允许通过父节点来选择相应的子节点 |
maxTagCount | Number | -1 | 当选中多个项目时,是否对显示在输入框中的条目精简显示 |
maxTagPlaceholder | Function | (v) => `+ ${v}...` | 当maxTagCount值设置后,选择超过指定数目的项后,级联器的输入值会精简显示为该方法返回的内容 |
filterable | Boolean | false | 是否通过输入过滤级联数据 |
clearable | Boolean | false | 是否可以通过清空输入框的方式删除全部选中的条目 |
allowDeleteByCloseIcon | Boolean | true | 允许通过Tag的关闭按钮来删除相应选中的条目 |
labelInValue | Boolean | false | 触发on-change事件时,返回的参数是否要被包装为传入的对象形式 |
multiple | Boolean | true | 默认为多选级联 |
transfer | Boolean | !this.$IVIEW || this.$IVIEW.transfer === '' ? false : this.$IVIEW.transfer | 下拉组件是否挂载到body元素上 |
placeholder | String | 请选择 | 未操作时的占位符 |
name | String | cascader | 该值用在级联器的输入框中的name属性上 |
headStyle | Object | {} | 控制级联框的行内样式,多用来控制级联框宽度,默认宽度为240px |