vue element plus Cascader 级联选择器

简介: vue element plus Cascader 级联选择器

当一个数据集合有清晰的层级结构时,可通过级联选择器逐级查看并选择。

TIP

在 SSR 场景下,您需要将组件包裹在 <client-only></client-only> 之中 (如: Nuxt) 和 SSG (e.g: VitePress).

基础用法#

有两种触发子菜单的方式

只需为 Cascader 的options属性指定选项数组即可渲染出一个级联选择器。 通过 props.expandTrigger 属性控制子节点的展开方式

Child options expand when clicked (default)

Child options expand when hovered

有禁用选项#

通过在数据源中设置 disabled 字段来声明该选项是禁用的

本例中,options指定的数组中的第一个元素含有disabled: true键值对,因此是禁用的。 在默认情况下,Cascader 会检查数据中每一项的disabled字段是否为true,如果你的数据中表示禁用含义的字段名不为disabled,可以通过props.disabled属性来指定(详见下方 API 表格)。 当然,valuelabelchildren这三个字段名也可以通过同样的方式指定。

可清空#

通过 clearable 设置输入框可清空

仅显示最后一级#

可以仅在输入框中显示选中项最后一级的标签,而不是选中项所在的完整路径。

属性show-all-levels定义了是否显示完整的路径,将其赋值为false则仅显示最后一级 将其赋值为 false 则仅显示最后一级。

多选#

在标签中添加 :props="props" 并设置 props = { multiple: true } 来开启多选模式。

正确用法:

<template>
  <el-cascader :props="props" />
</template>
<script lang="ts">
  export default {
    setup() {
      return {
        props: {
          // props.
          multiple: true,
        },
      }
    },
  }
</script>

错误用法:

<template>
  <!--  Object literal binging here is invalid syntax for cascader  -->
  <el-cascader :props="{ multiple: true }" />
</template>

使用多选时,所有选中的标签将默认显示。 您可以设置 collapse = true 将选中的标签折叠。 您可以设置 max-collapse-tags 来显示最大tag数量,默认1。 您可以使用 collapse-tags-tooltip 属性来启用鼠标悬停折叠文字以显示具体所选值的行为。

Display all tags (default)

Collapse tags

Collapse tags tooltip

Max Collapse Tags

选择任意一级选项#

在单选模式下,你只能选择叶子节点;而在多选模式下,勾选父节点真正选中的都是叶子节点。 启用该功能后,可让父子节点取消关联,选择任意一级选项。

可通过 props.checkStrictly = true 来设置父子节点取消选中关联,从而达到选择任意一级选项的目的。

Select any level of options (Single selection)

Select any level of options (Multiple selection)

动态加载#

当选中某一级时,动态加载该级下的选项。

通过lazy开启动态加载,并通过lazyload来设置加载数据源的方法。 lazyload方法有两个参数,第一个参数node为当前点击的节点,第二个resolve为数据加载完成的回调(必须调用)。 为了更准确的显示节点的状态,还可以对节点数据添加是否为叶子节点的标志位 (默认字段为leaf,可通过props.leaf修改)。 否则,将以有无子节点来判断其是否为叶子节点。

可搜索#

可以快捷地搜索选项并选择。

通过添加filterable来启用过滤。 Cascader 会匹配所有节点的标签和它们的亲节点的标签,是否包含有输入的关键字。 你也可以用filter-method自定义搜索逻辑,接受一个函数,第一个参数是节点node,第二个参数是搜索关键词keyword,通过返回布尔值表示是否命中。

Filterable (Single selection)

Filterable (Multiple selection)

自定义节点内容#

可以自定义备选项的节点内容

你可以通过 scoped slot 自定义节点的内容。 您可以访问 scope 中的 nodedata 属性,分别表示当前节点的 Node 对象和当前节点的数据。

级联面板#

级联面板是级联选择器的核心组件,与级联选择器一样,有单选、多选、动态加载等多种功能。

和级联选择器一样,通过 options 来指定选项,也可通过 props 来设置多选、动态加载等功能,具体详情见下方API表格。

  • Guide
  • Component
  • Resource

Cascader API#

Cascader Attributes#

属性名 说明 类型 默认值
model-value / v-model 选中项绑定值 string/number/object
options 选项的数据源, valuelabel 可以通过 CascaderProps 自定义. object
props 配置选项, 请参阅下面 CascaderProps 表。 object
size 尺寸 enum
placeholder 输入框占位文本 string
disabled 是否禁用 boolean
clearable 是否支持清空选项 boolean
show-all-levels 输入框中是否显示选中值的完整路径 boolean true
collapse-tags 多选模式下是否折叠Tag boolean
collapse-tags-tooltip 当鼠标悬停于折叠标签的文本时,是否显示所有选中的标签。 要使用此属性,collapse-tags属性必须设定为 true boolean false
separator 用于分隔选项的字符 string ' / '
filterable 该选项是否可以被搜索 boolean
filter-method 自定义搜索逻辑,第一个参数是node,第二个参数是keyword,返回的布尔值表示是否保留该选项 Function
debounce 搜索关键词正在输入时的去抖延迟,单位为毫秒 number 300
before-filter 过滤函数调用前,所要调用的钩子函数,该函数接收要过滤的值作为参数。 如果该函数的返回值是 false 或者是一个被拒绝的 Promise,那么接下来的过滤逻辑便不会执行。 Function
popper-class 弹出内容的自定义类名 string ''
teleported 弹层是否使用 teleport boolean true
popper-append-to-body deprecated 是否将弹出的内容直接插入到 body 元素。 在弹出内容的边框定位出现问题时,可将该属性设置为 false boolean true
tag-type 标签类型 enum info
validate-event 输入时是否触发表单的校验 boolean true
max-collapse-tags 2.3.10 需要显示的 Tag 的最大数量 只有当 collapse-tags 设置为 true 时才会生效。 number 1

Cascader Events#

事件名 说明 类型
change 当绑定值变化时触发的事件 Function
expand-change 当展开节点发生变化时触发 Function
blur 当失去焦点时触发 Function
focus 当获得焦点时触发 Function
visible-change 下拉框出现/隐藏时触发 Function
remove-tag 在多选模式下,移除Tag时触发 Function

Cascader Slots#

插槽名 说明 作用域
default 自定义备选项的节点内容,分别为当前节点的 Node 对象和数据 object
empty 无匹配选项时的内容

Cascader Exposes#

属性名 说明 类型
getCheckedNodes 获取一个当前选中节点的数组。(仅仅是传单) 是否只返回叶选中的节点,默认是 false Function
cascaderPanelRef cascader 面板的 ref object
togglePopperVisible 2.2.31 切换 popper 可见状态 Function
contentRef cascader 内容的 ref object

CascaderPanel API#

CascaderPanel Attributes#

属性名 说明 类型 默认值
model-value / v-model 选中项绑定值 string/number/object
options 选项的数据源, valuelabel 可以通过 CascaderProps 自定义. object
props 配置选项, 请参阅下面 CascaderProps 表。 object

CascaderPanel Events#

事件名 说明 Type
change 当选中节点变化时触发 Function
expand-change 当展开节点发生变化时触发 Function
close 面板的关闭事件,提供给 Cascader 以便做更好的判断。 Function

CascaderPanel Slots#

插槽名 说明 Scope
default 下级节点的自定义内容,它们分别是当前节点对象和节点数据。 object

CascaderPanel Exposes#

属性名 说明 Type
getCheckedNodes 获取一个当前选中节点的数组。(仅仅是传单) 是否只返回叶选中的节点,默认是 false Function
clearCheckedNodes 清空选中的节点 Function

CascaderProps#

属性 说明 类型 默认值
expandTrigger 次级菜单的展开方式 enum click
multiple 是否多选 boolean false
checkStrictly 是否严格的遵守父子节点不互相关联 boolean false
emitPath 在选中节点改变时,是否返回由该节点所在的各级菜单的值所组成的数组,若设置 false,则只返回该节点的值 boolean true
lazy 是否动态加载子节点,需与 lazyLoad 方法结合使用 boolean false
lazyLoad 加载动态数据的方法,仅在 lazy 为 true 时有效 Function
value 指定选项的值为选项对象的某个属性值 string value
label 指定选项标签为选项对象的某个属性值 string label
children 指定选项的子选项为选项对象的某个属性值 string children
disabled 指定选项的禁用为选项对象的某个属性值 string disabled
leaf 指定选项的叶子节点的标志位为选项对象的某个属性值 string leaf
hoverThreshold hover 时展开菜单的灵敏度阈值 number 500

类型声明#

显示类型声明

源代码#

组件文档

相关文章
Vue 中 key 属性的深入解析:改变 key 导致组件销毁与重建
Vue 中 key 属性的深入解析:改变 key 导致组件销毁与重建
239 0
Vue 表情包输入组件实现代码及详细开发流程解析
这是一篇关于 Vue 表情包输入组件的使用方法与封装指南的文章。通过安装依赖、全局注册和局部使用,可以快速集成表情包功能到 Vue 项目中。文章还详细介绍了组件的封装实现、高级配置(如自定义表情列表、主题定制、动画效果和懒加载)以及完整集成示例。开发者可根据需求扩展功能,例如 GIF 搜索或自定义表情上传,提升用户体验。资源链接提供进一步学习材料。
97 1
|
3月前
|
vue实现任务周期cron表达式选择组件
vue实现任务周期cron表达式选择组件
392 4
Vue 自定义进度条组件封装及使用方法详解
这是一篇关于自定义进度条组件的使用指南和开发文档。文章详细介绍了如何在Vue项目中引入、注册并使用该组件,包括基础与高级示例。组件支持分段配置(如颜色、文本)、动画效果及超出进度提示等功能。同时提供了完整的代码实现,支持全局注册,并提出了优化建议,如主题支持、响应式设计等,帮助开发者更灵活地集成和定制进度条组件。资源链接已提供,适合前端开发者参考学习。
194 17
如何高效实现 vue 文件批量下载及相关操作技巧
在Vue项目中,实现文件批量下载是常见需求。例如文档管理系统或图片库应用中,用户可能需要一次性下载多个文件。本文介绍了三种技术方案:1) 使用`file-saver`和`jszip`插件在前端打包文件为ZIP并下载;2) 借助后端接口完成文件压缩与传输;3) 使用`StreamSaver`解决大文件下载问题。同时,通过在线教育平台的实例详细说明了前后端的具体实现步骤,帮助开发者根据项目需求选择合适方案。
124 0
Vue 项目中如何自定义实用的进度条组件
本文介绍了如何使用Vue.js创建一个灵活多样的自定义进度条组件。该组件可接受进度段数据数组作为输入,动态渲染进度段,支持动画效果和内容展示。当进度超出总长时,超出部分将以红色填充。文章详细描述了组件的设计目标、实现步骤(包括props定义、宽度计算、模板渲染、动画处理及超出部分的显示),并提供了使用示例。通过此组件,开发者可根据项目需求灵活展示进度情况,优化用户体验。资源地址:[https://pan.quark.cn/s/35324205c62b](https://pan.quark.cn/s/35324205c62b)。
56 0
Vue框架中常见指令的应用概述。
通过以上的详细解析,你应该已经初窥Vue.js的指令的威力了。它们是Vue声明式编程模型的核心之一,无论是构建简单的静态网站还是复杂的单页面应用,你都会经常用到。记住,尽管Vue提供了大量预定义的指令,你还可以创建自定义指令以满足特定的需求。为你的Vue应用程序加上这些功能增强器,让编码变得更轻松、更愉快吧!
41 1
Vue 文件批量下载组件封装完整使用方法及优化方案解析
本文详细介绍了批量下载功能的技术实现与组件封装方案。主要包括两种实现方式:**前端打包方案(基于file-saver和jszip)** 和 **后端打包方案**。前者通过前端直接将文件打包为ZIP下载,适合小文件场景;后者由后端生成ZIP文件流返回,适用于大文件或大量文件下载。同时,提供了可复用的Vue组件`BatchDownload`,支持进度条、失败提示等功能。此外,还扩展了下载进度监控和断点续传等高级功能,并针对跨域、性能优化及用户体验改进提出了建议。可根据实际需求选择合适方案并快速集成到项目中。
208 17
Vue 表情包输入组件的实现代码:支持自定义表情库、快捷键发送和输入框联动的聊天表情解决方案
本文详细介绍了在 Vue 项目中实现一个功能完善、交互友好的表情包输入组件的方法,并提供了具体的应用实例。组件设计包含表情分类展示、响应式布局、与输入框的交互及样式定制等功能。通过核心技术实现,如将表情插入输入框光标位置和点击外部关闭选择器,确保用户体验流畅。同时探讨了性能优化策略,如懒加载和虚拟滚动,以及扩展性方案,如自定义主题和国际化支持。最终,展示了如何在聊天界面中集成该组件,为用户提供丰富的表情输入体验。
170 8
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等