何时使用
需要从一组相关联的数据集合进行选择,例如省市区,公司层级,事物分类等。
从一个较大的数据集合中进行选择时,用多级分类进行分隔,方便选择。
比起 Select 组件,可以在同一个浮层中完成选择,有较好的体验。
案例:省市区级联
核心代码:
<template>
<a-cascader v-model:value="value" :options="options" placeholder="Please select" />
</template>
<script setup>
import { ref } from 'vue';
const options = [
{
value: 'zhejiang',
label: 'Zhejiang',
children: [
{
value: 'hangzhou',
label: 'Hangzhou',
children: [
{
value: 'xihu',
label: 'West Lake',
},
],
},
],
},
{
value: 'jiangsu',
label: 'Jiangsu',
children: [
{
value: 'nanjing',
label: 'Nanjing',
children: [
{
value: 'zhonghuamen',
label: 'Zhong Hua Men',
},
],
},
],
},
];
const value = ref([]);
</script>
第一步:使用组件
<a-cascader v-model:value="value" :options="options" placeholder="Please select" />
第二步:定义options
- value:真实的值
- label:显示的标签
- children:级联选择,下级
const options = [
{
value: 'zhejiang',
label: 'Zhejiang',
children: [
{
value: 'hangzhou',
label: 'Hangzhou',
children: [
{
value: 'xihu',
label: 'West Lake',
},
],
},
],
}
]
vue3示例:
<script setup>
import {ref} from "vue";
const value = ref("")
const options = [
{
value: "浙江",
label: "浙江",
children:[
{
value: "杭州",
label: "杭州",
children: [
{
value: "西湖",
label: "西湖",
}
]
}
]
}
]
</script>
<template>
<div class="p-8 bg-indigo-50 text-center">
<a-cascader v-model:value="value" :options="options" placeholder="请选择"/>
</div>
</template>
案例:移入展开
通过移入展开下级菜单,点击完成选择。
核心代码:
<template>
<a-cascader
v-model:value="value"
:options="options"
expand-trigger="hover"
placeholder="Please select"
/>
</template>
<script setup>
import { ref } from 'vue';
const options = [
{
value: 'zhejiang',
label: 'Zhejiang',
children: [
{
value: 'hangzhou',
label: 'Hangzhou',
children: [
{
value: 'xihu',
label: 'West Lake',
},
],
},
],
},
{
value: 'jiangsu',
label: 'Jiangsu',
children: [
{
value: 'nanjing',
label: 'Nanjing',
children: [
{
value: 'zhonghuamen',
label: 'Zhong Hua Men',
},
],
},
],
},
];
const value = ref([]);
</script>
如何实现:expand-trigger="hover"
vue3示例:
<script setup>
import {ref} from "vue";
import axios from "axios";
const value = ref("")
const options = ref([])
axios.get('http://localhost:8888/city/areas2')
.then(function (response) {
// 处理成功情况
console.log(response);
const data = response.data
console.log("后端的数据:", data)
const areas = data.data
console.log("城市区县数据:", areas)
options.value = areas
})
.catch(function (error) {
// 处理错误情况
console.log(error);
})
.finally(function () {
// 总是会执行
});
</script>
<template>
<div class="p-8 bg-indigo-50 text-center">
<a-cascader
v-model:value="value"
:options="options"
placeholder="请选择"
expand-trigger="hover"
/>
</div>
</template>
案例:搜索
可以直接搜索选项并选择。
核心代码:
<template>
<a-cascader
v-model:value="value"
:options="options"
:show-search="{ filter }"
placeholder="Please select"
/>
</template>
<script setup>
import { ref } from 'vue';
const options = [
{
value: 'zhejiang',
label: 'Zhejiang',
children: [
{
value: 'hangzhou',
label: 'Hangzhou',
children: [
{
value: 'xihu',
label: 'West Lake',
},
{
value: 'xiasha',
label: 'Xia Sha',
disabled: true,
},
],
},
],
},
{
value: 'jiangsu',
label: 'Jiangsu',
children: [
{
value: 'nanjing',
label: 'Nanjing',
children: [
{
value: 'zhonghuamen',
label: 'Zhong Hua men',
},
],
},
],
},
];
const filter = (inputValue, path) => {
return path.some(option => option.label.toLowerCase().indexOf(inputValue.toLowerCase()) > -1);
};
const value = ref([]);
</script>
第一步:添加搜索功能
:show-search="{ filter }"
第二步:编写搜索方法
const filter = (inputValue, path) => {
return path.some(option => option.label.toLowerCase().indexOf(inputValue.toLowerCase()) > -1);
};
属性
参数 | 说明 | 类型 | 默认值 | Version |
allowClear | 是否支持清除 | boolean | true | |
autofocus | 自动获取焦点 | boolean | false | |
bordered | 是否有边框 | boolean | true | 3.2 |
clearIcon | 自定义的选择框清空图标 | slot | - | 3.2 |
changeOnSelect | (单选时生效)当此项为 true 时,点选每级菜单选项值都会发生变化,具体见上面的演示 | boolean | false | |
defaultValue | 默认的选中项 | string[] | number[] | [] | |
disabled | 禁用 | boolean | false | |
displayRender | 选择后展示的渲染函数,可使用 #displayRender=“{labels, selectedOptions}” | ({labels, selectedOptions}) => VNode |
labels => labels.join(' / ') |
|
popupClassName | 自定义浮层类名 | string | - | 4.0 |
dropdownStyle | 自定义浮层样式 | CSSProperties | {} | 3.0 |
expandIcon | 自定义次级菜单展开图标 | slot | - | 3.0 |
expandTrigger | 次级菜单的展开方式 | click |
hover |
‘click’ |
fieldNames | 自定义 options 中 label value children 的字段 |
object | { label: 'label', value: 'value', children: 'children' } |
|
getPopupContainer | 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。 | Function(triggerNode) | () => document.body | |
loadData | 用于动态加载选项,无法与 showSearch 一起使用 |
(selectedOptions) => void |
- | |
maxTagCount | 最多显示多少个 tag,响应式模式会对性能产生损耗 | number | responsive |
- | 3.0 |
maxTagPlaceholder | 隐藏 tag 时显示的内容 | v-slot | function(omittedValues) | - | 3.0 |
multiple | 支持多选节点 | boolean | - | 3.0 |
notFoundContent | 当下拉列表为空时显示的内容 | string | slot | ‘Not Found’ | |
open | 控制浮层显隐 | boolean | - | 3.0 |
options | 可选项数据源 | Option[] | - | |
placeholder | 输入框占位文本 | string | ‘请选择’ | |
placement | 浮层预设位置 | bottomLeft |
bottomRight |
topLeft |
showCheckedStrategy | 定义选中项回填的方式。Cascader.SHOW_CHILD : 只显示选中的子节点。Cascader.SHOW_PARENT : 只显示父节点(当父节点下所有子节点都选中时)。 |
Cascader.SHOW_PARENT |
Cascader.SHOW_CHILD |
Cascader.SHOW_PARENT |
removeIcon | 自定义的多选框清除图标 | slot | - | 3.2 |
searchValue | 设置搜索的值,需要与 showSearch 配合使用 |
string | - | 3.0 |
showSearch | 在选择框中显示搜索框 | boolean | object | false | |
status | 设置校验状态 | ‘error’ | ‘warning’ | - | 3.3.0 |
size | 输入框大小 | large |
default |
small |
suffixIcon | 自定义的选择框后缀图标 | string | VNode | slot | - | |
tagRender | 自定义 tag 内容,多选时生效 | slot | - | 3.0 |
value(v-model) | 指定选中项 | string[] | number[] | - |
showSearch 属性
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
filter | 接收 inputValue path 两个参数,当 path 符合筛选条件时,应返回 true,反之则返回 false。 |
function(inputValue, path): boolean |
|
limit | 搜索结果展示数量 | number | false | 50 |
matchInputWidth | 搜索结果列表是否与输入框同宽 | boolean | |
render | 用于渲染 filter 后的选项,可使用 #showSearchRender=“{inputValue, path}” | function({inputValue, path}): VNode |
|
sort | 用于排序 filter 后的选项 | function(a, b, inputValue) |
事件
事件名称 | 说明 | 回调参数 | 版本 | |
---|---|---|---|---|
change | 选择完成后的回调 | (value, selectedOptions) => void |
- | |
dropdownVisibleChange | 显示/隐藏浮层的回调 | (value) => void |
- | 3.0 |
search | 监听搜索,返回输入的值 | (value) => void |
- | 3.0 |