Cascader 级联选择器

Cascader 级联选择器

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

基础用法

有两种触发子菜单的方式

Cascader 级联选择器 - 图1

只需为 Cascader 的options属性指定选项数组即可渲染出一个级联选择器。通过props.expandTrigger可以定义展开子级菜单的触发方式。

<div class="block">  <span class="demonstration">默认 click 触发子菜单</span>  <el-cascader    v-model="value"    :options="options"    @change="handleChange"></el-cascader></div><div class="block">  <span class="demonstration">hover 触发子菜单</span>  <el-cascader    v-model="value"    :options="options"    :props="{ expandTrigger: 'hover' }"    @change="handleChange"></el-cascader></div><script>
export default {
  data() {
    return {
      value: [],
      options: [
        {
          value: "zhinan",
          label: "指南",
          children: [
            {
              value: "shejiyuanze",
              label: "设计原则",
              children: [
                { value: "yizhi", label: "一致" },
                { value: "fankui", label: "反馈" },
                { value: "xiaolv", label: "效率" },
                { value: "kekong", label: "可控" },
              ],
            },
            {
              value: "daohang",
              label: "导航",
              children: [
                { value: "cexiangdaohang", label: "侧向导航" },
                { value: "dingbudaohang", label: "顶部导航" },
              ],
            },
          ],
        },
        {
          value: "zujian",
          label: "组件",
          children: [
            {
              value: "basic",
              label: "Basic",
              children: [
                { value: "layout", label: "Layout 布局" },
                { value: "color", label: "Color 色彩" },
                { value: "typography", label: "Typography 字体" },
                { value: "icon", label: "Icon 图标" },
                { value: "button", label: "Button 按钮" },
              ],
            },
            {
              value: "form",
              label: "Form",
              children: [
                { value: "radio", label: "Radio 单选框" },
                { value: "checkbox", label: "Checkbox 多选框" },
                { value: "input", label: "Input 输入框" },
                { value: "input-number", label: "InputNumber 计数器" },
                { value: "select", label: "Select 选择器" },
                { value: "cascader", label: "Cascader 级联选择器" },
                { value: "switch", label: "Switch 开关" },
                { value: "slider", label: "Slider 滑块" },
                { value: "time-picker", label: "TimePicker 时间选择器" },
                { value: "date-picker", label: "DatePicker 日期选择器" },
                {
                  value: "datetime-picker",
                  label: "DateTimePicker 日期时间选择器",
                },
                { value: "upload", label: "Upload 上传" },
                { value: "rate", label: "Rate 评分" },
                { value: "form", label: "Form 表单" },
              ],
            },
            {
              value: "data",
              label: "Data",
              children: [
                { value: "table", label: "Table 表格" },
                { value: "tag", label: "Tag 标签" },
                { value: "progress", label: "Progress 进度条" },
                { value: "tree", label: "Tree 树形控件" },
                { value: "pagination", label: "Pagination 分页" },
                { value: "badge", label: "Badge 标记" },
              ],
            },
            {
              value: "notice",
              label: "Notice",
              children: [
                { value: "alert", label: "Alert 警告" },
                { value: "loading", label: "Loading 加载" },
                { value: "message", label: "Message 消息提示" },
                { value: "message-box", label: "MessageBox 弹框" },
                { value: "notification", label: "Notification 通知" },
              ],
            },
            {
              value: "navigation",
              label: "Navigation",
              children: [
                { value: "menu", label: "NavMenu 导航菜单" },
                { value: "tabs", label: "Tabs 标签页" },
                { value: "breadcrumb", label: "Breadcrumb 面包屑" },
                { value: "dropdown", label: "Dropdown 下拉菜单" },
                { value: "steps", label: "Steps 步骤条" },
              ],
            },
            {
              value: "others",
              label: "Others",
              children: [
                { value: "dialog", label: "Dialog 对话框" },
                { value: "tooltip", label: "Tooltip 文字提示" },
                { value: "popover", label: "Popover 弹出框" },
                { value: "card", label: "Card 卡片" },
                { value: "carousel", label: "Carousel 走马灯" },
                { value: "collapse", label: "Collapse 折叠面板" },
              ],
            },
          ],
        },
        {
          value: "ziyuan",
          label: "资源",
          children: [
            { value: "axure", label: "Axure Components" },
            { value: "sketch", label: "Sketch Templates" },
            { value: "jiaohu", label: "组件交互文档" },
          ],
        },
      ],
    };
  },
  methods: {
    handleChange(value) {
      console.log(value);
    },
  },
};
</script>

禁用选项

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

Cascader 级联选择器 - 图2

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

<el-cascader :options="options"></el-cascader><script>
export default {
  data() {
    return {
      options: [
        {
          value: "zhinan",
          label: "指南",
          disabled: true,
          children: [
            {
              value: "shejiyuanze",
              label: "设计原则",
              children: [
                { value: "yizhi", label: "一致" },
                { value: "fankui", label: "反馈" },
                { value: "xiaolv", label: "效率" },
                { value: "kekong", label: "可控" },
              ],
            },
            {
              value: "daohang",
              label: "导航",
              children: [
                { value: "cexiangdaohang", label: "侧向导航" },
                { value: "dingbudaohang", label: "顶部导航" },
              ],
            },
          ],
        },
        {
          value: "zujian",
          label: "组件",
          children: [
            {
              value: "basic",
              label: "Basic",
              children: [
                { value: "layout", label: "Layout 布局" },
                { value: "color", label: "Color 色彩" },
                { value: "typography", label: "Typography 字体" },
                { value: "icon", label: "Icon 图标" },
                { value: "button", label: "Button 按钮" },
              ],
            },
            {
              value: "form",
              label: "Form",
              children: [
                { value: "radio", label: "Radio 单选框" },
                { value: "checkbox", label: "Checkbox 多选框" },
                { value: "input", label: "Input 输入框" },
                { value: "input-number", label: "InputNumber 计数器" },
                { value: "select", label: "Select 选择器" },
                { value: "cascader", label: "Cascader 级联选择器" },
                { value: "switch", label: "Switch 开关" },
                { value: "slider", label: "Slider 滑块" },
                { value: "time-picker", label: "TimePicker 时间选择器" },
                { value: "date-picker", label: "DatePicker 日期选择器" },
                {
                  value: "datetime-picker",
                  label: "DateTimePicker 日期时间选择器",
                },
                { value: "upload", label: "Upload 上传" },
                { value: "rate", label: "Rate 评分" },
                { value: "form", label: "Form 表单" },
              ],
            },
            {
              value: "data",
              label: "Data",
              children: [
                { value: "table", label: "Table 表格" },
                { value: "tag", label: "Tag 标签" },
                { value: "progress", label: "Progress 进度条" },
                { value: "tree", label: "Tree 树形控件" },
                { value: "pagination", label: "Pagination 分页" },
                { value: "badge", label: "Badge 标记" },
              ],
            },
            {
              value: "notice",
              label: "Notice",
              children: [
                { value: "alert", label: "Alert 警告" },
                { value: "loading", label: "Loading 加载" },
                { value: "message", label: "Message 消息提示" },
                { value: "message-box", label: "MessageBox 弹框" },
                { value: "notification", label: "Notification 通知" },
              ],
            },
            {
              value: "navigation",
              label: "Navigation",
              children: [
                { value: "menu", label: "NavMenu 导航菜单" },
                { value: "tabs", label: "Tabs 标签页" },
                { value: "breadcrumb", label: "Breadcrumb 面包屑" },
                { value: "dropdown", label: "Dropdown 下拉菜单" },
                { value: "steps", label: "Steps 步骤条" },
              ],
            },
            {
              value: "others",
              label: "Others",
              children: [
                { value: "dialog", label: "Dialog 对话框" },
                { value: "tooltip", label: "Tooltip 文字提示" },
                { value: "popover", label: "Popover 弹出框" },
                { value: "card", label: "Card 卡片" },
                { value: "carousel", label: "Carousel 走马灯" },
                { value: "collapse", label: "Collapse 折叠面板" },
              ],
            },
          ],
        },
        {
          value: "ziyuan",
          label: "资源",
          children: [
            { value: "axure", label: "Axure Components" },
            { value: "sketch", label: "Sketch Templates" },
            { value: "jiaohu", label: "组件交互文档" },
          ],
        },
      ],
    };
  },
};
</script>

可清空

通过 clearable 设置输入框可清空

Cascader 级联选择器 - 图3

<el-cascader :options="options" clearable></el-cascader><script>
export default {
  data() {
    return {
      options: [
        {
          value: "zhinan",
          label: "指南",
          children: [
            {
              value: "shejiyuanze",
              label: "设计原则",
              children: [
                { value: "yizhi", label: "一致" },
                { value: "fankui", label: "反馈" },
                { value: "xiaolv", label: "效率" },
                { value: "kekong", label: "可控" },
              ],
            },
            {
              value: "daohang",
              label: "导航",
              children: [
                { value: "cexiangdaohang", label: "侧向导航" },
                { value: "dingbudaohang", label: "顶部导航" },
              ],
            },
          ],
        },
        {
          value: "zujian",
          label: "组件",
          children: [
            {
              value: "basic",
              label: "Basic",
              children: [
                { value: "layout", label: "Layout 布局" },
                { value: "color", label: "Color 色彩" },
                { value: "typography", label: "Typography 字体" },
                { value: "icon", label: "Icon 图标" },
                { value: "button", label: "Button 按钮" },
              ],
            },
            {
              value: "form",
              label: "Form",
              children: [
                { value: "radio", label: "Radio 单选框" },
                { value: "checkbox", label: "Checkbox 多选框" },
                { value: "input", label: "Input 输入框" },
                { value: "input-number", label: "InputNumber 计数器" },
                { value: "select", label: "Select 选择器" },
                { value: "cascader", label: "Cascader 级联选择器" },
                { value: "switch", label: "Switch 开关" },
                { value: "slider", label: "Slider 滑块" },
                { value: "time-picker", label: "TimePicker 时间选择器" },
                { value: "date-picker", label: "DatePicker 日期选择器" },
                {
                  value: "datetime-picker",
                  label: "DateTimePicker 日期时间选择器",
                },
                { value: "upload", label: "Upload 上传" },
                { value: "rate", label: "Rate 评分" },
                { value: "form", label: "Form 表单" },
              ],
            },
            {
              value: "data",
              label: "Data",
              children: [
                { value: "table", label: "Table 表格" },
                { value: "tag", label: "Tag 标签" },
                { value: "progress", label: "Progress 进度条" },
                { value: "tree", label: "Tree 树形控件" },
                { value: "pagination", label: "Pagination 分页" },
                { value: "badge", label: "Badge 标记" },
              ],
            },
            {
              value: "notice",
              label: "Notice",
              children: [
                { value: "alert", label: "Alert 警告" },
                { value: "loading", label: "Loading 加载" },
                { value: "message", label: "Message 消息提示" },
                { value: "message-box", label: "MessageBox 弹框" },
                { value: "notification", label: "Notification 通知" },
              ],
            },
            {
              value: "navigation",
              label: "Navigation",
              children: [
                { value: "menu", label: "NavMenu 导航菜单" },
                { value: "tabs", label: "Tabs 标签页" },
                { value: "breadcrumb", label: "Breadcrumb 面包屑" },
                { value: "dropdown", label: "Dropdown 下拉菜单" },
                { value: "steps", label: "Steps 步骤条" },
              ],
            },
            {
              value: "others",
              label: "Others",
              children: [
                { value: "dialog", label: "Dialog 对话框" },
                { value: "tooltip", label: "Tooltip 文字提示" },
                { value: "popover", label: "Popover 弹出框" },
                { value: "card", label: "Card 卡片" },
                { value: "carousel", label: "Carousel 走马灯" },
                { value: "collapse", label: "Collapse 折叠面板" },
              ],
            },
          ],
        },
        {
          value: "ziyuan",
          label: "资源",
          children: [
            { value: "axure", label: "Axure Components" },
            { value: "sketch", label: "Sketch Templates" },
            { value: "jiaohu", label: "组件交互文档" },
          ],
        },
      ],
    };
  },
};
</script>

仅显示最后一级

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

Cascader 级联选择器 - 图4

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

<el-cascader :options="options" :show-all-levels="false"></el-cascader><script>
export default {
  data() {
    return {
      options: [
        {
          value: "zhinan",
          label: "指南",
          children: [
            {
              value: "shejiyuanze",
              label: "设计原则",
              children: [
                { value: "yizhi", label: "一致" },
                { value: "fankui", label: "反馈" },
                { value: "xiaolv", label: "效率" },
                { value: "kekong", label: "可控" },
              ],
            },
            {
              value: "daohang",
              label: "导航",
              children: [
                { value: "cexiangdaohang", label: "侧向导航" },
                { value: "dingbudaohang", label: "顶部导航" },
              ],
            },
          ],
        },
        {
          value: "zujian",
          label: "组件",
          children: [
            {
              value: "basic",
              label: "Basic",
              children: [
                { value: "layout", label: "Layout 布局" },
                { value: "color", label: "Color 色彩" },
                { value: "typography", label: "Typography 字体" },
                { value: "icon", label: "Icon 图标" },
                { value: "button", label: "Button 按钮" },
              ],
            },
            {
              value: "form",
              label: "Form",
              children: [
                { value: "radio", label: "Radio 单选框" },
                { value: "checkbox", label: "Checkbox 多选框" },
                { value: "input", label: "Input 输入框" },
                { value: "input-number", label: "InputNumber 计数器" },
                { value: "select", label: "Select 选择器" },
                { value: "cascader", label: "Cascader 级联选择器" },
                { value: "switch", label: "Switch 开关" },
                { value: "slider", label: "Slider 滑块" },
                { value: "time-picker", label: "TimePicker 时间选择器" },
                { value: "date-picker", label: "DatePicker 日期选择器" },
                {
                  value: "datetime-picker",
                  label: "DateTimePicker 日期时间选择器",
                },
                { value: "upload", label: "Upload 上传" },
                { value: "rate", label: "Rate 评分" },
                { value: "form", label: "Form 表单" },
              ],
            },
            {
              value: "data",
              label: "Data",
              children: [
                { value: "table", label: "Table 表格" },
                { value: "tag", label: "Tag 标签" },
                { value: "progress", label: "Progress 进度条" },
                { value: "tree", label: "Tree 树形控件" },
                { value: "pagination", label: "Pagination 分页" },
                { value: "badge", label: "Badge 标记" },
              ],
            },
            {
              value: "notice",
              label: "Notice",
              children: [
                { value: "alert", label: "Alert 警告" },
                { value: "loading", label: "Loading 加载" },
                { value: "message", label: "Message 消息提示" },
                { value: "message-box", label: "MessageBox 弹框" },
                { value: "notification", label: "Notification 通知" },
              ],
            },
            {
              value: "navigation",
              label: "Navigation",
              children: [
                { value: "menu", label: "NavMenu 导航菜单" },
                { value: "tabs", label: "Tabs 标签页" },
                { value: "breadcrumb", label: "Breadcrumb 面包屑" },
                { value: "dropdown", label: "Dropdown 下拉菜单" },
                { value: "steps", label: "Steps 步骤条" },
              ],
            },
            {
              value: "others",
              label: "Others",
              children: [
                { value: "dialog", label: "Dialog 对话框" },
                { value: "tooltip", label: "Tooltip 文字提示" },
                { value: "popover", label: "Popover 弹出框" },
                { value: "card", label: "Card 卡片" },
                { value: "carousel", label: "Carousel 走马灯" },
                { value: "collapse", label: "Collapse 折叠面板" },
              ],
            },
          ],
        },
        {
          value: "ziyuan",
          label: "资源",
          children: [
            { value: "axure", label: "Axure Components" },
            { value: "sketch", label: "Sketch Templates" },
            { value: "jiaohu", label: "组件交互文档" },
          ],
        },
      ],
    };
  },
};
</script>

多选

可通过 props.multiple = true 来开启多选模式

Cascader 级联选择器 - 图5

在开启多选模式后,默认情况下会展示所有已选中的选项的Tag,你可以使用collapse-tags来折叠Tag

<div class="block">  <span class="demonstration">默认显示所有Tag</span>  <el-cascader    :options="options"    :props="props"    clearable></el-cascader></div><div class="block">  <span class="demonstration">折叠展示Tag</span>  <el-cascader    :options="options"    :props="props"    collapse-tags    clearable></el-cascader></div><script>
export default {
  data() {
    return {
      props: { multiple: true },
      options: [
        {
          value: 1,
          label: "东南",
          children: [
            {
              value: 2,
              label: "上海",
              children: [
                { value: 3, label: "普陀" },
                { value: 4, label: "黄埔" },
                { value: 5, label: "徐汇" },
              ],
            },
            {
              value: 7,
              label: "江苏",
              children: [
                { value: 8, label: "南京" },
                { value: 9, label: "苏州" },
                { value: 10, label: "无锡" },
              ],
            },
            {
              value: 12,
              label: "浙江",
              children: [
                { value: 13, label: "杭州" },
                { value: 14, label: "宁波" },
                { value: 15, label: "嘉兴" },
              ],
            },
          ],
        },
        {
          value: 17,
          label: "西北",
          children: [
            {
              value: 18,
              label: "陕西",
              children: [
                { value: 19, label: "西安" },
                { value: 20, label: "延安" },
              ],
            },
            {
              value: 21,
              label: "新疆维吾尔族自治区",
              children: [
                { value: 22, label: "乌鲁木齐" },
                { value: 23, label: "克拉玛依" },
              ],
            },
          ],
        },
      ],
    };
  },
};
</script>

选择任意一级选项

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

Cascader 级联选择器 - 图6

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

<div class="block">  <span class="demonstration">单选选择任意一级选项</span>  <el-cascader    :options="options"    :props="{ checkStrictly: true }"    clearable></el-cascader></div><div class="block">  <span class="demonstration">多选选择任意一级选项</span>  <el-cascader    :options="options"    :props="{ multiple: true, checkStrictly: true }"    clearable></el-cascader></div><script>
export default {
  data() {
    return {
      options: [
        {
          value: "zhinan",
          label: "指南",
          children: [
            {
              value: "shejiyuanze",
              label: "设计原则",
              children: [
                { value: "yizhi", label: "一致" },
                { value: "fankui", label: "反馈" },
                { value: "xiaolv", label: "效率" },
                { value: "kekong", label: "可控" },
              ],
            },
            {
              value: "daohang",
              label: "导航",
              children: [
                { value: "cexiangdaohang", label: "侧向导航" },
                { value: "dingbudaohang", label: "顶部导航" },
              ],
            },
          ],
        },
        {
          value: "zujian",
          label: "组件",
          children: [
            {
              value: "basic",
              label: "Basic",
              children: [
                { value: "layout", label: "Layout 布局" },
                { value: "color", label: "Color 色彩" },
                { value: "typography", label: "Typography 字体" },
                { value: "icon", label: "Icon 图标" },
                { value: "button", label: "Button 按钮" },
              ],
            },
            {
              value: "form",
              label: "Form",
              children: [
                { value: "radio", label: "Radio 单选框" },
                { value: "checkbox", label: "Checkbox 多选框" },
                { value: "input", label: "Input 输入框" },
                { value: "input-number", label: "InputNumber 计数器" },
                { value: "select", label: "Select 选择器" },
                { value: "cascader", label: "Cascader 级联选择器" },
                { value: "switch", label: "Switch 开关" },
                { value: "slider", label: "Slider 滑块" },
                { value: "time-picker", label: "TimePicker 时间选择器" },
                { value: "date-picker", label: "DatePicker 日期选择器" },
                {
                  value: "datetime-picker",
                  label: "DateTimePicker 日期时间选择器",
                },
                { value: "upload", label: "Upload 上传" },
                { value: "rate", label: "Rate 评分" },
                { value: "form", label: "Form 表单" },
              ],
            },
            {
              value: "data",
              label: "Data",
              children: [
                { value: "table", label: "Table 表格" },
                { value: "tag", label: "Tag 标签" },
                { value: "progress", label: "Progress 进度条" },
                { value: "tree", label: "Tree 树形控件" },
                { value: "pagination", label: "Pagination 分页" },
                { value: "badge", label: "Badge 标记" },
              ],
            },
            {
              value: "notice",
              label: "Notice",
              children: [
                { value: "alert", label: "Alert 警告" },
                { value: "loading", label: "Loading 加载" },
                { value: "message", label: "Message 消息提示" },
                { value: "message-box", label: "MessageBox 弹框" },
                { value: "notification", label: "Notification 通知" },
              ],
            },
            {
              value: "navigation",
              label: "Navigation",
              children: [
                { value: "menu", label: "NavMenu 导航菜单" },
                { value: "tabs", label: "Tabs 标签页" },
                { value: "breadcrumb", label: "Breadcrumb 面包屑" },
                { value: "dropdown", label: "Dropdown 下拉菜单" },
                { value: "steps", label: "Steps 步骤条" },
              ],
            },
            {
              value: "others",
              label: "Others",
              children: [
                { value: "dialog", label: "Dialog 对话框" },
                { value: "tooltip", label: "Tooltip 文字提示" },
                { value: "popover", label: "Popover 弹出框" },
                { value: "card", label: "Card 卡片" },
                { value: "carousel", label: "Carousel 走马灯" },
                { value: "collapse", label: "Collapse 折叠面板" },
              ],
            },
          ],
        },
        {
          value: "ziyuan",
          label: "资源",
          children: [
            { value: "axure", label: "Axure Components" },
            { value: "sketch", label: "Sketch Templates" },
            { value: "jiaohu", label: "组件交互文档" },
          ],
        },
      ],
    };
  },
};
</script>

动态加载

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

Cascader 级联选择器 - 图7

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

<el-cascader
  :options="options2"
  @active-item-change="handleItemChange"
  :props="props"
></el-cascader>
<script>
  export default {
    data() {
      return {
        options2: [{
          label: '江苏',
          cities: []
        }, {
          label: '浙江',
          cities: []
        }],
        props: {
          value: 'label',
          children: 'cities'
        }
      };
    },
    methods: {
      handleItemChange(val) {
        console.log('active item:', val);
        setTimeout(_ => {
          if (val.indexOf('江苏') > -1 && !this.options2[0].cities.length) {
            this.options2[0].cities = [{
              label: '南京'
            }];
          } else if (val.indexOf('浙江') > -1 && !this.options2[1].cities.length) {
            this.options2[1].cities = [{
              label: '杭州'
            }];
          }
        }, 300);
      }
    }
  };
</script>

可搜索

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

Cascader 级联选择器 - 图8

filterable赋值为true即可打开搜索功能,默认会匹配节点的label或所有父节点的label(由show-all-levels决定)中包含输入值的选项。你也可以用filter-method自定义搜索逻辑,接受一个函数,第一个参数是节点node,第二个参数是搜索关键词keyword,通过返回布尔值表示是否命中。

<div class="block">
  <span class="demonstration">只可选择最后一级菜单的选项</span>
  <el-cascader
    placeholder="试试搜索:指南"
    :options="options"
    filterable
  ></el-cascader>
</div>
<div class="block">
  <span class="demonstration">可选择任意一级菜单的选项</span>
  <el-cascader
    placeholder="试试搜索:指南"
    :options="options"
    filterable
    change-on-select
  ></el-cascader>
</div>
<script>
  export default {
    data() {
      return {
        options: [{
          value: 'zhinan',
          label: '指南',
          children: [{
            value: 'shejiyuanze',
            label: '设计原则',
            children: [{
              value: 'yizhi',
              label: '一致'
            }, {
              value: 'fankui',
              label: '反馈'
            }, {
              value: 'xiaolv',
              label: '效率'
            }, {
              value: 'kekong',
              label: '可控'
            }]
          }, {
            value: 'daohang',
            label: '导航',
            children: [{
              value: 'cexiangdaohang',
              label: '侧向导航'
            }, {
              value: 'dingbudaohang',
              label: '顶部导航'
            }]
          }]
        }, {
          value: 'zujian',
          label: '组件',
          children: [{
            value: 'basic',
            label: 'Basic',
            children: [{
              value: 'layout',
              label: 'Layout 布局'
            }, {
              value: 'color',
              label: 'Color 色彩'
            }, {
              value: 'typography',
              label: 'Typography 字体'
            }, {
              value: 'icon',
              label: 'Icon 图标'
            }, {
              value: 'button',
              label: 'Button 按钮'
            }]
          }, {
            value: 'form',
            label: 'Form',
            children: [{
              value: 'radio',
              label: 'Radio 单选框'
            }, {
              value: 'checkbox',
              label: 'Checkbox 多选框'
            }, {
              value: 'input',
              label: 'Input 输入框'
            }, {
              value: 'input-number',
              label: 'InputNumber 计数器'
            }, {
              value: 'select',
              label: 'Select 选择器'
            }, {
              value: 'cascader',
              label: 'Cascader 级联选择器'
            }, {
              value: 'switch',
              label: 'Switch 开关'
            }, {
              value: 'slider',
              label: 'Slider 滑块'
            }, {
              value: 'time-picker',
              label: 'TimePicker 时间选择器'
            }, {
              value: 'date-picker',
              label: 'DatePicker 日期选择器'
            }, {
              value: 'datetime-picker',
              label: 'DateTimePicker 日期时间选择器'
            }, {
              value: 'upload',
              label: 'Upload 上传'
            }, {
              value: 'rate',
              label: 'Rate 评分'
            }, {
              value: 'form',
              label: 'Form 表单'
            }]
          }, {
            value: 'data',
            label: 'Data',
            children: [{
              value: 'table',
              label: 'Table 表格'
            }, {
              value: 'tag',
              label: 'Tag 标签'
            }, {
              value: 'progress',
              label: 'Progress 进度条'
            }, {
              value: 'tree',
              label: 'Tree 树形控件'
            }, {
              value: 'pagination',
              label: 'Pagination 分页'
            }, {
              value: 'badge',
              label: 'Badge 标记'
            }]
          }, {
            value: 'notice',
            label: 'Notice',
            children: [{
              value: 'alert',
              label: 'Alert 警告'
            }, {
              value: 'loading',
              label: 'Loading 加载'
            }, {
              value: 'message',
              label: 'Message 消息提示'
            }, {
              value: 'message-box',
              label: 'MessageBox 弹框'
            }, {
              value: 'notification',
              label: 'Notification 通知'
            }]
          }, {
            value: 'navigation',
            label: 'Navigation',
            children: [{
              value: 'menu',
              label: 'NavMenu 导航菜单'
            }, {
              value: 'tabs',
              label: 'Tabs 标签页'
            }, {
              value: 'breadcrumb',
              label: 'Breadcrumb 面包屑'
            }, {
              value: 'dropdown',
              label: 'Dropdown 下拉菜单'
            }, {
              value: 'steps',
              label: 'Steps 步骤条'
            }]
          }, {
            value: 'others',
            label: 'Others',
            children: [{
              value: 'dialog',
              label: 'Dialog 对话框'
            }, {
              value: 'tooltip',
              label: 'Tooltip 文字提示'
            }, {
              value: 'popover',
              label: 'Popover 弹出框'
            }, {
              value: 'card',
              label: 'Card 卡片'
            }, {
              value: 'carousel',
              label: 'Carousel 走马灯'
            }, {
              value: 'collapse',
              label: 'Collapse 折叠面板'
            }]
          }]
        }, {
          value: 'ziyuan',
          label: '资源',
          children: [{
            value: 'axure',
            label: 'Axure Components'
          }, {
            value: 'sketch',
            label: 'Sketch Templates'
          }, {
            value: 'jiaohu',
            label: '组件交互文档'
          }]
        }]
      };
    }
  };
</script>

自定义节点内容

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

Cascader 级联选择器 - 图9

可以通过scoped slot对级联选择器的备选项的节点内容进行自定义,scoped slot会传入两个字段 nodedata,分别表示当前节点的 Node 对象和数据。

<el-cascader :options="options">  <template slot-scope="{ node, data }">    <span>{{ data.label }}</span>    <span v-if="!node.isLeaf"> ({{ data.children.length }}) </span>  </template></el-cascader><script>
export default {
  data() {
    return {
      options: [
        {
          value: "zhinan",
          label: "指南",
          children: [
            {
              value: "shejiyuanze",
              label: "设计原则",
              children: [
                { value: "yizhi", label: "一致" },
                { value: "fankui", label: "反馈" },
                { value: "xiaolv", label: "效率" },
                { value: "kekong", label: "可控" },
              ],
            },
            {
              value: "daohang",
              label: "导航",
              children: [
                { value: "cexiangdaohang", label: "侧向导航" },
                { value: "dingbudaohang", label: "顶部导航" },
              ],
            },
          ],
        },
        {
          value: "zujian",
          label: "组件",
          children: [
            {
              value: "basic",
              label: "Basic",
              children: [
                { value: "layout", label: "Layout 布局" },
                { value: "color", label: "Color 色彩" },
                { value: "typography", label: "Typography 字体" },
                { value: "icon", label: "Icon 图标" },
                { value: "button", label: "Button 按钮" },
              ],
            },
            {
              value: "form",
              label: "Form",
              children: [
                { value: "radio", label: "Radio 单选框" },
                { value: "checkbox", label: "Checkbox 多选框" },
                { value: "input", label: "Input 输入框" },
                { value: "input-number", label: "InputNumber 计数器" },
                { value: "select", label: "Select 选择器" },
                { value: "cascader", label: "Cascader 级联选择器" },
                { value: "switch", label: "Switch 开关" },
                { value: "slider", label: "Slider 滑块" },
                { value: "time-picker", label: "TimePicker 时间选择器" },
                { value: "date-picker", label: "DatePicker 日期选择器" },
                {
                  value: "datetime-picker",
                  label: "DateTimePicker 日期时间选择器",
                },
                { value: "upload", label: "Upload 上传" },
                { value: "rate", label: "Rate 评分" },
                { value: "form", label: "Form 表单" },
              ],
            },
            {
              value: "data",
              label: "Data",
              children: [
                { value: "table", label: "Table 表格" },
                { value: "tag", label: "Tag 标签" },
                { value: "progress", label: "Progress 进度条" },
                { value: "tree", label: "Tree 树形控件" },
                { value: "pagination", label: "Pagination 分页" },
                { value: "badge", label: "Badge 标记" },
              ],
            },
            {
              value: "notice",
              label: "Notice",
              children: [
                { value: "alert", label: "Alert 警告" },
                { value: "loading", label: "Loading 加载" },
                { value: "message", label: "Message 消息提示" },
                { value: "message-box", label: "MessageBox 弹框" },
                { value: "notification", label: "Notification 通知" },
              ],
            },
            {
              value: "navigation",
              label: "Navigation",
              children: [
                { value: "menu", label: "NavMenu 导航菜单" },
                { value: "tabs", label: "Tabs 标签页" },
                { value: "breadcrumb", label: "Breadcrumb 面包屑" },
                { value: "dropdown", label: "Dropdown 下拉菜单" },
                { value: "steps", label: "Steps 步骤条" },
              ],
            },
            {
              value: "others",
              label: "Others",
              children: [
                { value: "dialog", label: "Dialog 对话框" },
                { value: "tooltip", label: "Tooltip 文字提示" },
                { value: "popover", label: "Popover 弹出框" },
                { value: "card", label: "Card 卡片" },
                { value: "carousel", label: "Carousel 走马灯" },
                { value: "collapse", label: "Collapse 折叠面板" },
              ],
            },
          ],
        },
        {
          value: "ziyuan",
          label: "资源",
          children: [
            { value: "axure", label: "Axure Components" },
            { value: "sketch", label: "Sketch Templates" },
            { value: "jiaohu", label: "组件交互文档" },
          ],
        },
      ],
    };
  },
};
</script>

级联面板

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

Cascader 级联选择器 - 图10

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

<el-cascader-panel :options="options"></el-cascader-panel><script>
export default {
  data() {
    return {
      options: [
        {
          value: "zhinan",
          label: "指南",
          children: [
            {
              value: "shejiyuanze",
              label: "设计原则",
              children: [
                { value: "yizhi", label: "一致" },
                { value: "fankui", label: "反馈" },
                { value: "xiaolv", label: "效率" },
                { value: "kekong", label: "可控" },
              ],
            },
            {
              value: "daohang",
              label: "导航",
              children: [
                { value: "cexiangdaohang", label: "侧向导航" },
                { value: "dingbudaohang", label: "顶部导航" },
              ],
            },
          ],
        },
        {
          value: "zujian",
          label: "组件",
          children: [
            {
              value: "basic",
              label: "Basic",
              children: [
                { value: "layout", label: "Layout 布局" },
                { value: "color", label: "Color 色彩" },
                { value: "typography", label: "Typography 字体" },
                { value: "icon", label: "Icon 图标" },
                { value: "button", label: "Button 按钮" },
              ],
            },
            {
              value: "form",
              label: "Form",
              children: [
                { value: "radio", label: "Radio 单选框" },
                { value: "checkbox", label: "Checkbox 多选框" },
                { value: "input", label: "Input 输入框" },
                { value: "input-number", label: "InputNumber 计数器" },
                { value: "select", label: "Select 选择器" },
                { value: "cascader", label: "Cascader 级联选择器" },
                { value: "switch", label: "Switch 开关" },
                { value: "slider", label: "Slider 滑块" },
                { value: "time-picker", label: "TimePicker 时间选择器" },
                { value: "date-picker", label: "DatePicker 日期选择器" },
                {
                  value: "datetime-picker",
                  label: "DateTimePicker 日期时间选择器",
                },
                { value: "upload", label: "Upload 上传" },
                { value: "rate", label: "Rate 评分" },
                { value: "form", label: "Form 表单" },
              ],
            },
            {
              value: "data",
              label: "Data",
              children: [
                { value: "table", label: "Table 表格" },
                { value: "tag", label: "Tag 标签" },
                { value: "progress", label: "Progress 进度条" },
                { value: "tree", label: "Tree 树形控件" },
                { value: "pagination", label: "Pagination 分页" },
                { value: "badge", label: "Badge 标记" },
              ],
            },
            {
              value: "notice",
              label: "Notice",
              children: [
                { value: "alert", label: "Alert 警告" },
                { value: "loading", label: "Loading 加载" },
                { value: "message", label: "Message 消息提示" },
                { value: "message-box", label: "MessageBox 弹框" },
                { value: "notification", label: "Notification 通知" },
              ],
            },
            {
              value: "navigation",
              label: "Navigation",
              children: [
                { value: "menu", label: "NavMenu 导航菜单" },
                { value: "tabs", label: "Tabs 标签页" },
                { value: "breadcrumb", label: "Breadcrumb 面包屑" },
                { value: "dropdown", label: "Dropdown 下拉菜单" },
                { value: "steps", label: "Steps 步骤条" },
              ],
            },
            {
              value: "others",
              label: "Others",
              children: [
                { value: "dialog", label: "Dialog 对话框" },
                { value: "tooltip", label: "Tooltip 文字提示" },
                { value: "popover", label: "Popover 弹出框" },
                { value: "card", label: "Card 卡片" },
                { value: "carousel", label: "Carousel 走马灯" },
                { value: "collapse", label: "Collapse 折叠面板" },
              ],
            },
          ],
        },
        {
          value: "ziyuan",
          label: "资源",
          children: [
            { value: "axure", label: "Axure Components" },
            { value: "sketch", label: "Sketch Templates" },
            { value: "jiaohu", label: "组件交互文档" },
          ],
        },
      ],
    };
  },
};
</script>

Cascader Attributes

参数 说明 类型 可选值 默认值
value / v-model 选中项绑定值 -
options 可选项数据源,键名可通过 Props 属性配置 array
props 配置选项,具体见下表 object
size 尺寸 string medium / small / mini
placeholder 输入框占位文本 string 请选择
disabled 是否禁用 boolean false
clearable 是否支持清空选项 boolean false
show-all-levels 输入框中是否显示选中值的完整路径 boolean true
collapse-tags 多选模式下是否折叠Tag boolean - false
separator 选项分隔符 string 斜杠’ / ‘
filterable 是否可搜索选项 boolean
filter-method 自定义搜索逻辑,第一个参数是节点node,第二个参数是搜索关键词keyword,通过返回布尔值表示是否命中 function(node, keyword) - -
debounce 搜索关键词输入的去抖延迟,毫秒 number 300
before-filter 筛选之前的钩子,参数为输入的值,若返回 false 或者返回 Promise 且被 reject,则停止筛选 function(value)
popper-class 自定义浮层类名 string

Cascader Events

事件名称 说明 回调参数
change 当选中节点变化时触发 选中节点的值
expand-change 当展开节点发生变化时触发 各父级选项值组成的数组
blur 当失去焦点时触发 (event: Event)
focus 当获得焦点时触发 (event: Event)
visible-change 下拉框出现/隐藏时触发 出现则为 true,隐藏则为 false
remove-tag 在多选模式下,移除Tag时触发 移除的Tag对应的节点的值

Cascader Methods

方法名 说明 参数
getCheckedNodes 获取选中的节点 (leafOnly) 是否只是叶子节点,默认值为 false

Cascader Slots

名称 说明
- 自定义备选项的节点内容,参数为 { node, data },分别为当前节点的 Node 对象和数据
empty 无匹配选项时的内容

CascaderPanel Attributes

参数 说明 类型 可选值 默认值
value / v-model 选中项绑定值 -
options 可选项数据源,键名可通过 Props 属性配置 array
props 配置选项,具体见下表 object

CascaderPanel Events

事件名称 说明 回调参数
change 当选中节点变化时触发 选中节点的值
expand-change 当展开节点发生变化时触发 各父级选项值组成的数组

CascaderPanel Methods

方法名 说明 参数
getCheckedNodes 获取选中的节点数组 (leafOnly) 是否只是叶子节点,默认值为 false
clearCheckedNodes 清空选中的节点 -

CascaderPanel Slots

名称 说明
- 自定义备选项的节点内容,参数为 { node, data },分别为当前节点的 Node 对象和数据

Props

参数 说明 类型 可选值 默认值
expandTrigger 次级菜单的展开方式 string click / hover ‘click’
multiple 是否多选 boolean - false
checkStrictly 是否严格的遵守父子节点不互相关联 boolean - false
emitPath 在选中节点改变时,是否返回由该节点所在的各级菜单的值所组成的数组,若设置 false,则只返回该节点的值 boolean - true
lazy 是否动态加载子节点,需与 lazyLoad 方法结合使用 boolean - false
lazyLoad 加载动态数据的方法,仅在 lazy 为 true 时有效 function(node, resolve),node为当前点击的节点,resolve为数据加载完成的回调(必须调用) - -
value 指定选项的值为选项对象的某个属性值 string ‘value’
label 指定选项标签为选项对象的某个属性值 string ‘label’
children 指定选项的子选项为选项对象的某个属性值 string ‘children’
disabled 指定选项的禁用为选项对象的某个属性值 string ‘disabled’
leaf 指定选项的叶子节点的标志位为选项对象的某个属性值 string ‘leaf’