Chips help people enter information, make selections, filter content, or trigger actions.
Element
igc-chip
Slots
default — Renders content in the default slot of the chip.
prefix — Renders content at the start of the chip, before the default content.
suffix — Renders content at the end of the chip after the default content.
select — Content to render when the chip in selected state.
remove — Content to override the default remove chip icon.
CSS Parts
base — The base wrapper of the chip.
content — The wrapper element around the default slot of the chip.
prefix — The prefix container of the chip.
suffix — The suffix container of the chip.

Constructors

Section titled "Constructors"

IgcChipComponent 

new IgcChipComponent(): IgcChipComponent

Defined in src/components/chip/chip.ts:132

Returns IgcChipComponent

Properties

Section titled "Properties"

disabled

Section titled "disabled"

Sets the disabled state for the chip.

 
disabled: boolean = false

Defined in src/components/chip/chip.ts:68

removable

Section titled "removable"

Defines if the chip is removable or not.

 
removable: boolean = false

Defined in src/components/chip/chip.ts:75

selectable

Section titled "selectable"

Defines if the chip is selectable or not.

 
selectable: boolean = false

Defined in src/components/chip/chip.ts:82

selected

Section titled "selected"

Defines if the chip is selected or not.

 
selected: boolean = false

Defined in src/components/chip/chip.ts:90

variant

Section titled "variant"

A property that sets the color variant of the chip component.

 
variant: StyleVariant

Defined in src/components/chip/chip.ts:97

styles

Section titled "styles" 
styles: CSSResult[]

Defined in src/components/chip/chip.ts:50

tagName

Section titled "tagName"

The tagName read-only property of the Element interface returns the tag name of the element on which it's called.

MDN Reference

 
tagName: "igc-chip" = 'igc-chip'

Defined in src/components/chip/chip.ts:49

Accessors

Section titled "Accessors"

locale

Section titled "locale" 
get locale(): string

Defined in src/components/chip/chip.ts:108

Returns string

Gets/Sets the locale used for getting language, affecting resource strings.

 
set locale(value: string): void

Defined in src/components/chip/chip.ts:104

Parameters

  • value: string

Returns void

resourceStrings

Section titled "resourceStrings" 
get resourceStrings(): IChipResourceStrings

Defined in src/components/chip/chip.ts:121

Returns IChipResourceStrings

The resource strings for localization. Currently only aria-labels for the default select/remove icons are localized.

 
set resourceStrings(value: IChipResourceStrings): void

Defined in src/components/chip/chip.ts:117

Parameters

  • value: IChipResourceStrings

Returns void

Methods

Section titled "Methods"

addEventListener

Section titled "addEventListener"

Inherited from: EventEmitterMixin< IgcChipComponentEventMap, Constructor<LitElement> >(LitElement) 

addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): void

Defined in src/components/common/mixins/event-emitter.ts:7

Parameters

  • type: K
  • listener: object
  • options: boolean | AddEventListenerOptions

Returns void

emitEvent

Section titled "emitEvent"

Inherited from: EventEmitterMixin< IgcChipComponentEventMap, Constructor<LitElement> >(LitElement) 

emitEvent(type: K, eventInitDict: CustomEventInit<D>): boolean

Defined in src/components/common/mixins/event-emitter.ts:30

Parameters

  • type: K
  • eventInitDict: CustomEventInit<D>

Returns boolean

removeEventListener

Section titled "removeEventListener"

Inherited from: EventEmitterMixin< IgcChipComponentEventMap, Constructor<LitElement> >(LitElement) 

removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): void

Defined in src/components/common/mixins/event-emitter.ts:17

Parameters

  • type: K
  • listener: object
  • options: boolean | EventListenerOptions

Returns void

register

Section titled "register" 
register(): void

Defined in src/components/chip/chip.ts:53

Returns void

Events

Section titled "Events"

igcRemove

Section titled "igcRemove" 
igcRemove: CustomEvent<boolean>

Defined in src/components/chip/chip.ts:22

igcSelect

Section titled "igcSelect" 
igcSelect: CustomEvent<boolean>

Defined in src/components/chip/chip.ts:23