import CascadeSelect from 'primevue/cascadeselect';
CascadeSelect requires a value to bind and a collection of arbitrary objects with a nested hierarchy. optionGroupLabel is used for the text of a category and optionGroupChildren is to define the children of the category. Note that order of the optionGroupChildren matters and it should correspond to the data hierarchy.
<CascadeSelect v-model="selectedCity" :options="countries" optionLabel="cname" optionGroupLabel="name"
:optionGroupChildren="['states', 'cities']" style="minWidth: 14rem" >
data() {
data() {
return {
selectedCity: null,
countries: [
{
name: 'Australia',
code: 'AU',
states: [
{
name: 'New South Wales',
cities: [
{cname: 'Sydney', code: 'A-SY'},
{cname: 'Newcastle', code: 'A-NE'},
{cname: 'Wollongong', code: 'A-WO'}
]
},
{
name: 'Queensland',
cities: [
{cname: 'Brisbane', code: 'A-BR'},
{cname: 'Townsville', code: 'A-TO'}
]
},
]
},
{
name: 'Canada',
code: 'CA',
states: [
{
name: 'Quebec',
cities: [
{cname: 'Montreal', code: 'C-MO'},
{cname: 'Quebec City', code: 'C-QU'}
]
},
{
name: 'Ontario',
cities: [
{cname: 'Ottawa', code: 'C-OT'},
{cname: 'Toronto', code: 'C-TO'}
]
},
]
},
{
name: 'United States',
code: 'US',
states: [
{
name: 'California',
cities: [
{cname: 'Los Angeles', code: 'US-LA'},
{cname: 'San Diego', code: 'US-SD'},
{cname: 'San Francisco', code: 'US-SF'}
]
},
{
name: 'Florida',
cities: [
{cname: 'Jacksonville', code: 'US-JA'},
{cname: 'Miami', code: 'US-MI'},
{cname: 'Tampa', code: 'US-TA'},
{cname: 'Orlando', code: 'US-OR'}
]
},
{
name: 'Texas',
cities: [
{cname: 'Austin', code: 'US-AU'},
{cname: 'Dallas', code: 'US-DA'},
{cname: 'Houston', code: 'US-HO'}
]
}
]
}
]
}
}
}
Content of an item can be customized with the option template.
<CascadeSelect v-model="selectedCity" :options="countries" optionLabel="cname" optionGroupLabel="name"
:optionGroupChildren="['states', 'cities']" style="minWidth: 14rem">
<template #option="slotProps">
<div class="country-item">
<img src="../../assets/images/flag_placeholder.png" :class="'flag flag-' + slotProps.option.code.toLowerCase()" v-if="slotProps.option.states" />
<i class="pi pi-compass p-mr-2" v-if="slotProps.option.cities"></i>
<i class="pi pi-map-marker p-mr-2" v-if="slotProps.option.cname"></i>
<span>{{slotProps.option.cname || slotProps.option.name}}</span>
</div>
</template>
</CascadeSelect>
Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.
| Name | Type | Default | Description |
|---|---|---|---|
| modelValue | any | null | Value of the component. |
| options | array | null | An array of selectitems to display as the available options. |
| optionLabel | string | null | Property name or getter function to use as the label of an option. |
| optionValue | string | null | Property name or getter function to use as the value of an option, defaults to the option itself when not defined. |
| optionGroupLabel | string | null | Property name or getter function to use as the label of an option group. |
| optionGroupChildren | string | null | Property name or getter function to retrieve the items of a group. |
| placeholder | string | null | Default text to display when no option is selected. |
| disabled | boolean | false | When present, it specifies that the component should be disabled. |
| dataKey | string | null | A property to uniquely identify an option. |
| tabindex | number | null | Index of the element in tabbing order. |
| inputId | string | null | Identifier of the underlying input element. |
| ariaLabelledBy | string | null | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
| appendTo | string | body | A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are "body" for document body and "self" for the element itself. |
| panelClass | string | null | Style class of the overlay panel. |
| Name | Parameters | Description |
|---|---|---|
| change | event.originalEvent: Original event event.value: Selected option value |
Callback to invoke on value change. |
| group-change | event.originalEvent: Original event event.value: Selected option group |
Callback to invoke when a group changes. |
| before-show | - | Callback to invoke before the overlay is shown. |
| before-hide | - | Callback to invoke before the overlay is hidden. |
| show | - | Callback to invoke when the overlay is shown. |
| hide | - | Callback to invoke when the overlay is hidden. |
| Name | Parameters |
|---|---|
| value | value: Value of the component placeholder: Placeholder text to show |
Following is the list of structural style classes, for theming classes visit
| Name | Element |
|---|---|
| p-cascadeselect | Container element. |
| p-cascadeselect-label | Element to display label of selected option. |
| p-cascadeselect-trigger | Icon element. |
| p-cascadeselect-panel | Icon element. |
| p-cascadeselect-items-wrapper | Wrapper element of items list. |
| p-cascadeselect-items | List element of items. |
| p-cascadeselect-item | An item in the list. |
None.