New to Kendo UI for Vue? Start a free 30-day trial

Chip

Component

Represents the Kendo UI for Vue Chip component. Accepts properties of type ChipProps. Use the Chip to show a short piece of information, such as a tag or a filter.

Definition

Package:@progress/kendo-vue-buttons

Properties Interface:ChipProps

Syntax:

vue
<Chip :text="'Pending'" :value="'pending'" :removable="true" />

Properties

Sets the IDs of the elements that describe the Chip, like the HTML aria-describedby attribute. For example, these elements can contain an error or a hint message.

Sets the accessible name of the Chip.

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.

Sets the data item of the Chip. The ChipList passes it to the Chip.

dir?

string

Sets the direction of the Chip. Accepts ltr or rtl.

Default:

'ltr'

disabled?

boolean

Sets whether the Chip is disabled.

Default:

false

fillMode?

"solid" | "outline" | "flat"

Sets the fill style of the Chip.

The available options are:

  • solid
  • outline
  • flat
Default:

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 Chip.

onBlur?

(event: ChipFocusEvent) => void

Fires when the Chip loses the focus. The event name is blur.

Parameters:eventChipFocusEvent

onClick?

(event: ChipMouseEvent) => void

Fires when the user clicks the Chip. The event name is click.

Parameters:eventChipMouseEvent

onFocus?

(event: ChipFocusEvent) => void

Fires when the Chip gets the focus. The event name is focus.

Parameters:eventChipFocusEvent

Fires when the user presses a key while the Chip has the focus. The event name is keydown.

Parameters:eventChipKeyboardEvent

onRemove?

(event: ChipRemoveEvent) => void

Fires when the user removes the Chip. The event name is remove.

Parameters:eventChipRemoveEvent

removable?

boolean

Sets whether the user can remove the Chip.

Default:

false

Sets the name of a custom remove icon.

Default:

'x-circle'

Sets the SVGIcon of the remove action in the Chip.

Default:

xCircleIcon

rounded?

"small" | "medium" | "large" | "none" | "full"

Sets the border radius of the Chip.

The available options are:

  • none
  • small
  • medium
  • large
  • full
Default:

undefined

selected?

boolean

Sets whether the Chip is selected.

Sets the name of a custom icon that the Chip shows when it is selected.

Default:

'check'

Sets the SVGIcon that the Chip shows when it is selected.

Default:

checkIcon

size?

"small" | "medium" | "large"

Sets the size of the Chip.

The available options are:

  • small
  • medium
  • large
Default:

undefined

svgIcon?

SVGIcon

Sets the SVGIcon that the Chip shows.

tabIndex?

number

Sets the tabindex attribute of the Chip.

text?

string

Sets the label text of the Chip.

themeColor?

"base" | "info" | "success" | "warning" | "error"

Sets the theme color of the Chip.

The available options are:

  • base
  • info
  • success
  • warning
  • error
Default:

undefined

Sets the value of the Chip. The Chip uses it as its id value.

References

Represents the target (element and props) of the ChipRemoveEvent.