Components/Lists/Table
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/taglist
Tag lists are groups of tag and button components. They show active keywords or filters applied to a data table.
<Table.SubToolbar/> component.<Badge/> instead.A tag list consists of any number of tags followed by 2 action buttons:
toggleMoreButton to expand/collapse the list.actionButton to control bulk list actions (e.g., Clear All).Both buttons are optional. The order of the tags and buttons is fixed.
Control the size of entire tag lists with size prop:
tiny in dense spaces where a small list does not fit.small (default) in all default cases.medium in bigger layouts.large when tag lists need to be emphasized.Customize individual tags with <Tag/> component props:
theme.thumb.disabled.removable .maxWidth. If a label is longer, text gets truncated with ellipses.See <Tag/> for a full prop description.
Control the appearance of toggleMoreButton with skin and priority props.
Set its skin as standard and priority as secondary to emphasize the component actionButton on the left.
Limit the number of visible tags with maxVisibleTags prop (default is 3).
Use it to fit a tag list in one line and keep the layout compact.
If tags surpass the limit, give an option to expand the full list with toggleMoreButton prop.
Note that if the component width is larger than the parent container, it will display on multiple lines when expanded.
Define whether the list is expanded initially with an initiallyExpanded prop.
Use a tag list to show which filters are applied in a <Table/>.
| Name | Type | Default | Description |
|---|---|---|---|
actionButton | TagListActionButtonProps | — | Defines the label of an action button and its onClick function. |
dataHook | string | — | Applies a data-hook HTML attribute to be used in the tests. |
initiallyExpanded | boolean | false | Defines whether the list is: - initially expanded (shows all tags) - or collapsed (shows tags up to the max visible number) |
maxVisibleTags | number | 3 | Sets an amount of tags to show before expanding. |
onTagRemove | (id: string) => void | — | Defines a callback function that passes an id property as a parameter when removing a tag. |
overflowMode | "collapse" | TagListCollapseOverflowConfig | — | Controls how tags that don't fit the container are handled. - 'collapse' — tags auto-fit the container width and the rest collapse into a +N chip whose tooltip lists their labels. - Object form ({ type: 'collapse', renderTag, overflowTooltipContent }) — same behavior with per-feature configuration. When set, maxVisibleTags, toggleMoreButton, and initiallyExpanded are ignored. Costly for very large lists (each tag is rendered twice for measurement); prefer manual collapse via maxVisibleTags for large tag arrays. Tags collapsed into the +N chip aren't interactive — their labels appear in the chip's tooltip, but their remove buttons are unreachable. For removable tags prefer maxVisibleTags + toggleMoreButton, which lets users expand the list and reach every tag. |
size | "small" | "tiny" | "medium" | "large" | 'small' | Sets the size of a component. |
tags (required) | TagListTag[] | — | Lists all component's tags and its properties. |
toggleMoreButton | (amountOfHiddenTags: number, isExpanded: boolean) => ToggleMoreButtonProps | — | Defines a function which provides props for the ToggleMoreButton. ##### toggleMoreButton signature is: function(amountOfHiddenTags: number, isExpanded: boolean) => ToggleMoreButtonProps ##### ToggleMoreButtonProps: * label: string * tooltipContent: node * tooltipProps: TooltipCommonProps |
Import the driver matching your test environment:
| Method | Description |
|---|---|
actionButtonLabel | Get the action button label. |
clickActionButton | Click action button. |
actionButtonExists | Get if action button exists. |
toggleMoreButtonLabel | Get the toggle more button label. |
clickToggleMoreButton | Click toggle more button |
toggleMoreButtonExists | Get if toggle more button exists. |
removeTag | Remove tag by id. |
overflowChipExists | Get if the responsive +N overflow chip exists. |
overflowChipLabel | Get the responsive +N overflow chip text (e.g. "+3"). |
focusOverflowChip | Focus the responsive +N overflow chip. |
isOverflowChipFocused | Whether the responsive +N overflow chip is currently focused. |
exists | Checks whether the component found with the given data hook. |
element | Gets the component root element. |
click | Clicks on the component root element. |
base | Returns UniDriver for the base element. |
Last updated: 29 October 2026