packages/eui/packages/components/eui-chip-list/eui-chip-list.component.ts
Multiple eui-chips displayed dynamically as a group of multiple interactive elements.
AfterViewInit
AfterContentInit
OnDestroy
OnChanges
OnInit
changeDetection | ChangeDetectionStrategy.OnPush |
HostDirectives |
BaseStatesDirective
Inputs : euiPrimary euiSecondary euiSuccess euiInfo euiWarning euiDanger euiAccent euiVariant euiOutline euiDisabled
|
providers |
EuiChipListDragService
|
selector | eui-chip-list, div[euiChipList], ul[euiChipList] |
imports |
NgTemplateOutlet
DragDropModule
TranslateModule
EuiTruncatePipe
EuiTooltipDirective
EUI_CHIP
EUI_BUTTON
EUI_ICON
|
templateUrl | ./eui-chip-list.component.html |
styleUrl | ./eui-chip-list.scss |
Properties |
|
Methods |
|
Inputs |
Outputs |
HostBindings |
Accessors |
ariaLabel |
Type : string
|
Default value : 'eUI Chip List'
|
Sets the |
chips |
Type : any[]
|
Array of chips to display in the list when used with the data approach. |
chipsLabelTruncateCount |
Type : any
|
Default value : null
|
Whether the chips label length are limited by the value of this option. |
chipsSortOrder |
Type : "ASC" | "DESC"
|
Default value : 'ASC'
|
In combination with |
dragAndDropConnectedTo |
Type : string[]
|
Default value : []
|
In combination with |
dragAndDropSourceName |
Type : string
|
In combination with |
dropListOrientation |
Type : "horizontal" | "vertical"
|
Default value : 'horizontal'
|
In combination with |
isChipsDragAndDrop |
Type : boolean
|
Default value : false
|
Whether the chips can be drag and dropped. |
isChipsRemovable |
Type : boolean
|
Default value : false
|
Whether the chip can be removed from the list. |
isChipsSorted |
Type : boolean
|
Default value : false
|
Whether this chips are sorted on their label. |
isGrid |
Type : boolean
|
Default value : false
|
In combination with |
isMaxVisibleChipsOpened |
Type : boolean
|
Default value : false
|
In combination with |
isSquared |
Type : boolean
|
Default value : false
|
maxVisibleChipsCount |
Type : any
|
Default value : null
|
Whether a limited amount, defined by this option, is used to display the chips. |
toggleLinkLessLabel |
Type : string
|
Default value : null
|
In combination with |
toggleLinkMoreLabel |
Type : string
|
Default value : null
|
In combination with |
chipDragRelease |
Type : EventEmitter
|
Event emitted when a chip drag is released. |
chipDragStart |
Type : EventEmitter
|
Event emitted when a chip drag starts. |
chipDrop |
Type : EventEmitter
|
Event emitted when a chip drag is released. |
chiplistFocus |
Type : EventEmitter
|
Event emitted when the list gets the focus. |
chipRemove |
Type : EventEmitter
|
Event emitted when a chip is removed from the list. |
chipsInit |
Type : EventEmitter
|
Event emitted with |
class |
Type : string
|
Public drop | ||||||||
drop(e: CdkDragDrop
|
||||||||
Drag and Drop chip handler used when a chip is moved inside a container.
Parameters :
Returns :
void
|
Public getChipContent | ||||||
getChipContent(euiChip: any)
|
||||||
Parameters :
Returns :
string
|
Public getChipIconAfter | ||||||||
getChipIconAfter(euiChip: any)
|
||||||||
Method that returns a boolean indicating of an icon has been declared after the label.
Parameters :
Returns :
boolean
|
Public getChipIconBefore | ||||||||
getChipIconBefore(euiChip: any)
|
||||||||
Method that returns a boolean indicating if an icon has been declared before the label.
Parameters :
Returns :
boolean
|
Public getChipLabel | ||||||
getChipLabel(euiChip: any)
|
||||||
Parameters :
Returns :
string
|
Public onDragEnter | ||||||||
onDragEnter(event: CdkDragEnter)
|
||||||||
Drag and Drop chip handler used when a chip is moved to another container.
Parameters :
Returns :
void
|
Public onDragReleased | ||||||||
onDragReleased(event: CdkDragRelease)
|
||||||||
Method called when a chip is released after dragging.
Parameters :
Returns :
void
|
Public onDragStarted | ||||||||
onDragStarted(event: CdkDragStart)
|
||||||||
Method called when a chip starts to be dragged.
Parameters :
Returns :
void
|
Public onDropGrid | ||||||
onDropGrid(e: CdkDragDrop
|
||||||
Method called when a chip is dropped.
Parameters :
Returns :
void
|
onFocus |
onFocus()
|
Method called when the list gets the focus.
Returns :
void
|
Public onRemove | ||||||||
onRemove(removed: EuiChipComponent | EuiChip | literal type | any)
|
||||||||
Remove chip from the list handler
Parameters :
Returns :
void
|
Public toggleTags |
toggleTags()
|
Method toggling the display of the chips in combination with
Returns :
void
|
chipListDragAndDropItems |
Type : CdkDropList
|
Decorators :
@ViewChild('chipListDragAndDropItems', {read: CdkDropList})
|
chipListDropList |
Type : CdkDropList
|
Decorators :
@ViewChild('chipListDropList', {read: CdkDropList})
|
Public connectComponent |
Type : CdkDropList[]
|
Default value : []
|
Public droppableArea |
Type : (CdkDropList | string)[]
|
Public e2eAttr |
Type : string
|
Default value : 'eui-chip-list'
|
euiChipItems |
Type : QueryList<ElementRef>
|
Decorators :
@ViewChildren('euiChipItem', {read: ElementRef})
|
euiChipsContent |
Type : QueryList<EuiChipComponent>
|
Decorators :
@ContentChildren(undefined)
|
cssClasses |
getcssClasses()
|
Computes and returns the CSS classes for the label title component based on its current state.
Returns :
string
|