# vm-select

**Repository Path**: deepsky/vm-select

## Basic Information

- **Project Name**: vm-select
- **Description**: 基于 vue2.x 的 select 组件
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://deepsky.gitee.io/vm-select/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-16
- **Last Updated**: 2021-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vm-select
![vm-select](https://img.shields.io/npm/v/vm-select.svg?style=flat)
## 安装
`npm`安装包
```javascript
yarn add -D vm-select
//or 
npm install -D vm-select 
```
全局引入
```javascript
import vmSelect from 'vm-select'
Vue.use(vmSelect)
```
or组件内引入
```javascript
import vmSelect from 'vm-select'

export default {
  ...
  components: {
    vmSelect
  }
  ...
}
```
使用方式
```javascript
<template>
  <div id="app">
    <vm-select :options="option" v-model="models"></vm-select>
  </div>
</template>

<script>
export default {
  data () {
    return {
      option: [1, 2, 3, 4, 5],
      model: 1
    }
  }
}
</script>
```
## API
### select props
| 属性    | 说明 | 类型| 默认值
| ------- | ---------------------------|----------|--------
| value   | 可以使用 v-model 双向绑定数据 | Array, String, Number| |
| options | 数据集合 | Array |  |
| multiple | 是否多选 |  Boolean | false |
| maxMultiple | 多选上限个数 |  Number | 100000 |
| clear | 清除选项 |   Boolean | true |
| search | 是否开启筛选 | Boolean | false |
| label | option 项显示属性 |  String |  |
| labelKey | option 返回项 |  String |  |
| disabled | 是否禁用 |  Boolean |  false |
| customDisabled | 是否禁用option项 |  Function |   |
| placeholder | placeholder 为空提示文案 |  String |  请输入  |
| maxRender | 最大 |  Number |  50  |
### select events
| 事件名称    | 说明 | 返回值
| ------- | -----------------------------------|----------
| on-change | option 被点击时触发 | value，option(当前项)
| on-maxnum-warn | Boolean 触发多选最大数量时回调 | false