mirror of https://github.com/ElemeFE/element
659 lines
16 KiB
Markdown
659 lines
16 KiB
Markdown
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
list: null,
|
||
options: [{
|
||
value: '选项1',
|
||
label: '黄金糕'
|
||
}, {
|
||
value: '选项2',
|
||
label: '双皮奶'
|
||
}, {
|
||
value: '选项3',
|
||
label: '蚵仔煎'
|
||
}, {
|
||
value: '选项4',
|
||
label: '龙须面'
|
||
}, {
|
||
value: '选项5',
|
||
label: '北京烤鸭'
|
||
}],
|
||
options2: [{
|
||
value: '选项1',
|
||
label: '黄金糕'
|
||
}, {
|
||
value: '选项2',
|
||
label: '双皮奶',
|
||
disabled: true
|
||
}, {
|
||
value: '选项3',
|
||
label: '蚵仔煎'
|
||
}, {
|
||
value: '选项4',
|
||
label: '龙须面'
|
||
}, {
|
||
value: '选项5',
|
||
label: '北京烤鸭'
|
||
}],
|
||
options3: [{
|
||
label: '热门城市',
|
||
options: [{
|
||
value: 'Shanghai',
|
||
label: '上海'
|
||
}, {
|
||
value: 'Beijing',
|
||
label: '北京'
|
||
}]
|
||
}, {
|
||
label: '城市名',
|
||
options: [{
|
||
value: 'Chengdu',
|
||
label: '成都'
|
||
}, {
|
||
value: 'Shenzhen',
|
||
label: '深圳'
|
||
}, {
|
||
value: 'Guangzhou',
|
||
label: '广州'
|
||
}, {
|
||
value: 'Dalian',
|
||
label: '大连'
|
||
}]
|
||
}],
|
||
options4: [],
|
||
options5: [{
|
||
value: 'HTML',
|
||
label: 'HTML'
|
||
}, {
|
||
value: 'CSS',
|
||
label: 'CSS'
|
||
}, {
|
||
value: 'JavaScript',
|
||
label: 'JavaScript'
|
||
}],
|
||
cities: [{
|
||
value: 'Beijing',
|
||
label: '北京'
|
||
}, {
|
||
value: 'Shanghai',
|
||
label: '上海'
|
||
}, {
|
||
value: 'Nanjing',
|
||
label: '南京'
|
||
}, {
|
||
value: 'Chengdu',
|
||
label: '成都'
|
||
}, {
|
||
value: 'Shenzhen',
|
||
label: '深圳'
|
||
}, {
|
||
value: 'Guangzhou',
|
||
label: '广州'
|
||
}],
|
||
value: '',
|
||
value2: '',
|
||
value3: '',
|
||
value4: '',
|
||
value5: [],
|
||
value6: '',
|
||
value7: '',
|
||
value8: '',
|
||
value9: '',
|
||
value10: [],
|
||
loading: false,
|
||
states: ["Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming"]
|
||
};
|
||
},
|
||
|
||
mounted() {
|
||
this.list = this.states.map(item => { return { value: item, label: item }; });
|
||
},
|
||
|
||
methods: {
|
||
remoteMethod(query) {
|
||
if (query !== '') {
|
||
this.loading = true;
|
||
setTimeout(() => {
|
||
this.loading = false;
|
||
this.options4 = this.list.filter(item => item.label.toLowerCase().indexOf(query.toLowerCase()) > -1);
|
||
}, 200);
|
||
} else {
|
||
this.options4 = [];
|
||
}
|
||
}
|
||
}
|
||
};
|
||
</script>
|
||
|
||
<style>
|
||
.demo-select .el-select {
|
||
display: inline-block;
|
||
width: 240px;
|
||
}
|
||
</style>
|
||
|
||
## Select 选择器
|
||
|
||
当选项过多时，使用下拉菜单展示并选择内容。
|
||
|
||
### 基础用法
|
||
|
||
适用广泛的基础单选
|
||
:::demo `v-model`的值为当前被选中的`el-option`的 value 属性值
|
||
```html
|
||
<template>
|
||
<el-select v-model="value" placeholder="请选择">
|
||
<el-option
|
||
v-for="item in options"
|
||
:label="item.label"
|
||
:value="item.value">
|
||
</el-option>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: [{
|
||
value: '选项1',
|
||
label: '黄金糕'
|
||
}, {
|
||
value: '选项2',
|
||
label: '双皮奶'
|
||
}, {
|
||
value: '选项3',
|
||
label: '蚵仔煎'
|
||
}, {
|
||
value: '选项4',
|
||
label: '龙须面'
|
||
}, {
|
||
value: '选项5',
|
||
label: '北京烤鸭'
|
||
}],
|
||
value: ''
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### 有禁用选项
|
||
|
||
:::demo 在`el-option`中，设定`disabled`值为 true，即可禁用该选项
|
||
```html
|
||
<template>
|
||
<el-select v-model="value2" placeholder="请选择">
|
||
<el-option
|
||
v-for="item in options2"
|
||
:label="item.label"
|
||
:value="item.value"
|
||
:disabled="item.disabled">
|
||
</el-option>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
options2: [{
|
||
value: '选项1',
|
||
label: '黄金糕'
|
||
}, {
|
||
value: '选项2',
|
||
label: '双皮奶',
|
||
disabled: true
|
||
}, {
|
||
value: '选项3',
|
||
label: '蚵仔煎'
|
||
}, {
|
||
value: '选项4',
|
||
label: '龙须面'
|
||
}, {
|
||
value: '选项5',
|
||
label: '北京烤鸭'
|
||
}],
|
||
value2: ''
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### 禁用状态
|
||
|
||
选择器不可用状态
|
||
|
||
:::demo 为`el-select`设置`disabled`属性，则整个选择器不可用
|
||
```html
|
||
<template>
|
||
<el-select v-model="value3" disabled placeholder="请选择">
|
||
<el-option
|
||
v-for="item in options"
|
||
:label="item.label"
|
||
:value="item.value">
|
||
</el-option>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: [{
|
||
value: '选项1',
|
||
label: '黄金糕'
|
||
}, {
|
||
value: '选项2',
|
||
label: '双皮奶'
|
||
}, {
|
||
value: '选项3',
|
||
label: '蚵仔煎'
|
||
}, {
|
||
value: '选项4',
|
||
label: '龙须面'
|
||
}, {
|
||
value: '选项5',
|
||
label: '北京烤鸭'
|
||
}],
|
||
value3: ''
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### 可清空单选
|
||
|
||
包含清空按钮，可将选择器清空为初始状态
|
||
|
||
:::demo 为`el-select`设置`clearable`属性，则可将选择器清空。需要注意的是，`clearable`属性仅适用于单选。
|
||
```html
|
||
<template>
|
||
<el-select v-model="value4" clearable placeholder="请选择">
|
||
<el-option
|
||
v-for="item in options"
|
||
:label="item.label"
|
||
:value="item.value">
|
||
</el-option>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: [{
|
||
value: '选项1',
|
||
label: '黄金糕'
|
||
}, {
|
||
value: '选项2',
|
||
label: '双皮奶'
|
||
}, {
|
||
value: '选项3',
|
||
label: '蚵仔煎'
|
||
}, {
|
||
value: '选项4',
|
||
label: '龙须面'
|
||
}, {
|
||
value: '选项5',
|
||
label: '北京烤鸭'
|
||
}],
|
||
value4: ''
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### 基础多选
|
||
|
||
适用性较广的基础多选，用 Tag 展示已选项
|
||
|
||
:::demo 为`el-select`设置`multiple`属性即可启用多选，此时`v-model`的值为当前选中值所组成的数组
|
||
```html
|
||
<template>
|
||
<el-select v-model="value5" multiple placeholder="请选择">
|
||
<el-option
|
||
v-for="item in options"
|
||
:label="item.label"
|
||
:value="item.value">
|
||
</el-option>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: [{
|
||
value: '选项1',
|
||
label: '黄金糕'
|
||
}, {
|
||
value: '选项2',
|
||
label: '双皮奶'
|
||
}, {
|
||
value: '选项3',
|
||
label: '蚵仔煎'
|
||
}, {
|
||
value: '选项4',
|
||
label: '龙须面'
|
||
}, {
|
||
value: '选项5',
|
||
label: '北京烤鸭'
|
||
}],
|
||
value5: []
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### 自定义模板
|
||
|
||
可以自定义备选项
|
||
|
||
:::demo 将自定义的 HTML 模板插入`el-option`的 slot 中即可。
|
||
```html
|
||
<template>
|
||
<el-select v-model="value6" placeholder="请选择">
|
||
<el-option
|
||
v-for="item in cities"
|
||
:label="item.label"
|
||
:value="item.value">
|
||
<span style="float: left">{{ item.label }}</span>
|
||
<span style="float: right; color: #8492a6; font-size: 13px">{{ item.value }}</span>
|
||
</el-option>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
cities: [{
|
||
value: 'Beijing',
|
||
label: '北京'
|
||
}, {
|
||
value: 'Shanghai',
|
||
label: '上海'
|
||
}, {
|
||
value: 'Nanjing',
|
||
label: '南京'
|
||
}, {
|
||
value: 'Chengdu',
|
||
label: '成都'
|
||
}, {
|
||
value: 'Shenzhen',
|
||
label: '深圳'
|
||
}, {
|
||
value: 'Guangzhou',
|
||
label: '广州'
|
||
}],
|
||
value6: ''
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### 分组
|
||
|
||
备选项进行分组展示
|
||
|
||
:::demo 使用`el-option-group`对备选项进行分组，它的`label`属性为分组名
|
||
```html
|
||
<template>
|
||
<el-select v-model="value7" placeholder="请选择">
|
||
<el-option-group
|
||
v-for="group in options3"
|
||
:label="group.label">
|
||
<el-option
|
||
v-for="item in group.options"
|
||
:label="item.label"
|
||
:value="item.value">
|
||
</el-option>
|
||
</el-option-group>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
options3: [{
|
||
label: '热门城市',
|
||
options: [{
|
||
value: 'Shanghai',
|
||
label: '上海'
|
||
}, {
|
||
value: 'Beijing',
|
||
label: '北京'
|
||
}]
|
||
}, {
|
||
label: '城市名',
|
||
options: [{
|
||
value: 'Chengdu',
|
||
label: '成都'
|
||
}, {
|
||
value: 'Shenzhen',
|
||
label: '深圳'
|
||
}, {
|
||
value: 'Guangzhou',
|
||
label: '广州'
|
||
}, {
|
||
value: 'Dalian',
|
||
label: '大连'
|
||
}]
|
||
}],
|
||
value7: ''
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### 可搜索
|
||
|
||
可以利用搜索功能快速查找选项
|
||
|
||
:::demo 为`el-select`添加`filterable`属性即可启用搜索功能。默认情况下，Select 会找出所有`label`属性包含输入值的选项。如果希望使用其他的搜索逻辑，可以通过传入一个`filter-method`来实现。`filter-method`为一个`Function`，它会在输入值发生变化时调用，参数为当前输入值。
|
||
```html
|
||
<template>
|
||
<el-select v-model="value8" filterable placeholder="请选择">
|
||
<el-option
|
||
v-for="item in options"
|
||
:label="item.label"
|
||
:value="item.value">
|
||
</el-option>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: [{
|
||
value: '选项1',
|
||
label: '黄金糕'
|
||
}, {
|
||
value: '选项2',
|
||
label: '双皮奶'
|
||
}, {
|
||
value: '选项3',
|
||
label: '蚵仔煎'
|
||
}, {
|
||
value: '选项4',
|
||
label: '龙须面'
|
||
}, {
|
||
value: '选项5',
|
||
label: '北京烤鸭'
|
||
}],
|
||
value8: ''
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### 远程搜索
|
||
|
||
从服务器搜索数据，输入关键字进行查找
|
||
:::demo 为了启用远程搜索，需要将`filterable`和`remote`设置为`true`，同时传入一个`remote-method`。`remote-method`为一个`Function`，它会在输入值发生变化时调用，参数为当前输入值。需要注意的是，如果`el-option`是通过`v-for`指令渲染出来的，此时需要为`el-option`添加`key`属性，且其值需具有唯一性，比如此例中的`item.value`。
|
||
```html
|
||
<template>
|
||
<el-select
|
||
v-model="value9"
|
||
multiple
|
||
filterable
|
||
remote
|
||
placeholder="请输入关键词"
|
||
:remote-method="remoteMethod"
|
||
:loading="loading">
|
||
<el-option
|
||
v-for="item in options4"
|
||
:key="item.value"
|
||
:label="item.label"
|
||
:value="item.value">
|
||
</el-option>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
options4: [],
|
||
value9: [],
|
||
list: [],
|
||
loading: false,
|
||
states: ["Alabama", "Alaska", "Arizona",
|
||
"Arkansas", "California", "Colorado",
|
||
"Connecticut", "Delaware", "Florida",
|
||
"Georgia", "Hawaii", "Idaho", "Illinois",
|
||
"Indiana", "Iowa", "Kansas", "Kentucky",
|
||
"Louisiana", "Maine", "Maryland",
|
||
"Massachusetts", "Michigan", "Minnesota",
|
||
"Mississippi", "Missouri", "Montana",
|
||
"Nebraska", "Nevada", "New Hampshire",
|
||
"New Jersey", "New Mexico", "New York",
|
||
"North Carolina", "North Dakota", "Ohio",
|
||
"Oklahoma", "Oregon", "Pennsylvania",
|
||
"Rhode Island", "South Carolina",
|
||
"South Dakota", "Tennessee", "Texas",
|
||
"Utah", "Vermont", "Virginia",
|
||
"Washington", "West Virginia", "Wisconsin",
|
||
"Wyoming"]
|
||
}
|
||
},
|
||
mounted() {
|
||
this.list = this.states.map(item => {
|
||
return { value: item, label: item };
|
||
});
|
||
},
|
||
methods: {
|
||
remoteMethod(query) {
|
||
if (query !== '') {
|
||
this.loading = true;
|
||
setTimeout(() => {
|
||
this.loading = false;
|
||
this.options4 = this.list.filter(item => {
|
||
return item.label.toLowerCase()
|
||
.indexOf(query.toLowerCase()) > -1;
|
||
});
|
||
}, 200);
|
||
} else {
|
||
this.options4 = [];
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### 创建条目
|
||
可以创建并选中选项中不存在的条目
|
||
:::demo 使用`allow-create`属性即可通过在输入框中输入文字来创建新的条目。注意此时`filterable`必须为真。
|
||
```html
|
||
<template>
|
||
<el-select
|
||
v-model="value10"
|
||
multiple
|
||
filterable
|
||
allow-create
|
||
placeholder="请选择文章标签">
|
||
<el-option
|
||
v-for="item in options5"
|
||
:label="item.label"
|
||
:value="item.value">
|
||
</el-option>
|
||
</el-select>
|
||
</template>
|
||
|
||
<script>
|
||
export default {
|
||
data() {
|
||
return {
|
||
options5: [{
|
||
value: 'HTML',
|
||
label: 'HTML'
|
||
}, {
|
||
value: 'CSS',
|
||
label: 'CSS'
|
||
}, {
|
||
value: 'JavaScript',
|
||
label: 'JavaScript'
|
||
}],
|
||
value10: []
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### Select Attributes
|
||
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
||
|---------- |-------------- |---------- |-------------------------------- |-------- |
|
||
| multiple | 是否多选 | boolean | — | false |
|
||
| disabled | 是否禁用 | boolean | — | false |
|
||
| clearable | 单选时是否可以清空选项 | boolean | — | false |
|
||
| multiple-limit | 多选时用户最多可以选择的项目数，为 0 则不限制 | number | — | 0 |
|
||
| name | select input 的 name 属性 | string | — | — |
|
||
| placeholder | 占位符 | string | — | 请选择 |
|
||
| filterable | 是否可搜索 | boolean | — | false |
|
||
| allow-create | 是否允许用户创建新条目，需配合 `filterable` 使用 | boolean | — | false |
|
||
| filter-method | 自定义过滤方法 | function | — | — |
|
||
| remote | 是否为远程搜索 | boolean | — | false |
|
||
| remote-method | 远程搜索方法 | function | — | — |
|
||
| loading | 是否正在从远程获取数据 | boolean | — | false |
|
||
|
||
### Select Events
|
||
| 事件名称 | 说明 | 回调参数 |
|
||
|---------|---------|---------|
|
||
| change | 选中值发生变化时触发 | 目前的选中值 |
|
||
|
||
### Option Group Attributes
|
||
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
||
|---------- |-------------- |---------- |-------------------------------- |-------- |
|
||
| label | 分组的组名 | string | — | — |
|
||
| disabled | 是否将该分组下所有选项置为禁用 | boolean | — | false |
|
||
|
||
### Option Attributes
|
||
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
||
|---------- |-------------- |---------- |-------------------------------- |-------- |
|
||
| value | 选项的值 | string/number/object | — | — |
|
||
| label | 选项的标签，若不设置则默认与 `value` 相同 | string/number | — | — |
|
||
| disabled | 是否禁用该选项 | boolean | — | false |
|