2.23.0

Chip List

Chip List Component in Bolt

Published

History
View changes
Install
yarn add @bolt/components-chip-list
Source code
View on Github
Dependencies
@bolt/components-chip @bolt/components-list @bolt/core-v3.x

Overview

Chip-list can contain multiple chips. Part of the Bolt “Components” CSS framework that powers the Bolt Design System.

Install via NPM
npm install @bolt/components-chip-list
Overview Usage Schema Edit this page Testing Steps

Usage

  {% include "@bolt-components-chip-list/chip-list.twig" with {
  items: [
    {
      text: "Chip 1",
      url: "#!"
    },
    {
      text: "Chip 2",
      url: "#!"
    },
    {
      text: "Chip 3",
      url: "#!"
    }
  ]
} only %}

Schema

Note: when assigning component props as HTML attributes on a web component, make sure to use kebab-case.

Prop Name Description Type Default Value Option(s)
items

An array of Chips.

 array —
  • [items]:
    • Type: object

      Chip.
size

Sets the size used for all of the chips (if size isn't specified on the individual chip)

 string —
  • xsmall, small, medium
truncate

Sets the max number of chips to show before truncating, 0 or greater

 number —
  • —
collapsible

Allows users to collapse items after expanding by clicking a close button.

 boolean false
  • —
id

Unique ID for Chip List, randomly generated if not provided (required for no-JS functionality).

 string —
  • —
contentItems

Deprecated (will be removed in Bolt v3.0) - use the items prop instead.

 array —
  • [items]:
    • Type: object

      Chip.
Open Accordion Close Accordion
expanded

Shows truncated items.

 boolean false
  • —
Debug Panel