ChipList
Represents the Kendo UI for Vue ChipList component. Accepts properties of type ChipListProps. Use the ChipList to show a set of Chips that the user can select or remove.
Definition
Package:@progress/kendo-vue-buttons
Properties Interface:ChipListProps
Syntax:
<ChipList :data-items="statuses" :selection="'multiple'" />
Properties
ariaDescribedBy?
string
Sets the IDs of the elements that describe the ChipList, like the HTML aria-describedby attribute.
For example, these elements can contain an error or a hint message.
ariaLabel?
string
Sets the accessible name of the Chip.
ariaLabelledBy?
string
Sets the IDs of the elements that label the ChipList.
avatar?
string | Object | Function
Sets the avatar of the Chip. When you set it to a ChipAvatarProps object with imageUrl and imageAlt, the Chip renders a default avatar.
When you set it to a string or a render function, it defines the avatar template.
avatarField?
object
Sets the field of the data item that provides the avatar of each Chip.
'avatar'
chip?
any
Sets a custom template for each Chip.
Accepts a slot name, a render function, or a Vue component. The template receives the dataItem, text, value, and size of the Chip.
className?
string
Sets additional classes to the ChipList.
dataItem?
any
Sets the data item of the Chip. The ChipList passes it to the Chip.
dataItems?
any
Sets the data of the child Chips.
defaultDataItems?
any[]
Sets the initial data of the child Chips.
[]
Sets the initial values of the selected Chips.
null
dir?
string
Sets the direction of the ChipList. Accepts ltr or rtl.
'ltr'
disabled?
boolean
Sets whether the ChipList is disabled.
false
fillMode?
"solid" | "outline" | "flat"
Sets the fill style of the Chips.
The available options are:
- solid
- outline
- flat
undefined
icon?
string
Sets the name of the icon that the Chip shows.
id?
string
Sets the id property of the top div element of the ChipList.
name?
string
Sets the name property of the input DOM element.
onBlur?
(event: ChipFocusEvent) => void
Fires when the Chip loses the focus. The event name is blur.
onChange?
(event: ChipListChangeEvent) => void
Fires when the selection changes. The event name is change.
onClick?
(event: ChipMouseEvent) => void
Fires when the user clicks the Chip. The event name is click.
onDatachange?
(event: ChipListDataChangeEvent) => void
Fires when the data of the Chips changes, for example when the user removes a Chip. The event name is datachange.
onFocus?
(event: ChipFocusEvent) => void
Fires when the Chip gets the focus. The event name is focus.
onKeydown?
(event: ChipKeyboardEvent) => void
Fires when the user presses a key while the Chip has the focus. The event name is keydown.
onRemove?
(event: ChipRemoveEvent) => void
Fires when the user removes the Chip. The event name is remove.
removable?
boolean
Sets whether the user can remove the Chip.
false
removeIcon?
string
Sets the name of a custom remove icon.
'x-circle'
removeSvgIcon?
SVGIcon
Sets the SVGIcon of the remove action in the Chip.
xCircleIcon
required?
boolean
Sets whether null is a valid value for the component.
rounded?
"small" | "medium" | "large" | "none" | "full"
Sets the border radius of the Chips.
The available options are:
- none
- small
- medium
- large
- full
undefined
selected?
boolean
Sets whether the Chip is selected.
selectedIcon?
string
Sets the name of a custom icon that the Chip shows when it is selected.
'check'
selectedSvgIcon?
SVGIcon
Sets the SVGIcon that the Chip shows when it is selected.
checkIcon
selection?
string
Sets the selection mode of the ChipList. Accepts none, single, or multiple.
'none'
size?
"small" | "medium" | "large"
Sets the size of the Chips.
The available options are:
- small
- medium
- large
undefined
svgIcon?
SVGIcon
Sets the SVGIcon that the Chip shows.
tabIndex?
number
Sets the tabindex attribute of the ChipList.
text?
string
Sets the label text of the Chip.
textField?
string
Sets the field of the data item that provides the text of each Chip.
'text'
themeColor?
"base" | "info" | "success" | "warning" | "error"
Sets the theme color of the Chip.
The available options are:
- base
- info
- success
- warning
- error
undefined
valid?
boolean
Overrides the validity state of the component.
When you set valid, the component ignores the required property.
validationMessage?
string
Sets the form error message of the component. If you set it to an empty string, the component shows no error.
validityStyles?
boolean
Shows or hides the invalid state styles of the component. When you set it to false, the component shows no invalid state styles.
value?
any
Sets the values of the selected Chips.
valueField?
string
Sets the field of the data item that provides the value of each Chip.
'value'
References
Represents the target (element and props) of the ChipListChangeEvent.