npm_versionnpm Paragon package page

The ChipCarousel component creates a scrollable horizontal block of chips with buttons for navigating to the previous and next set of chips.

Basic Usage

Any Paragon component or export may be added to the code example.

Theme Variables#

CSS VariableComputed Value










Props API#

ChipCarousel Props API
  • className string

    Specifies class name for the ChipCarousel.

  • items Array<React.ReactElement> Required

    Specifies array of Chip elements to be rendered inside the carousel.

  • ariaLabel string Required

    Text describing the ChipCarousel for screen readers.

  • disableOpacityMasks boolean

    Whether the default opacity masks should be shown at the start/end, if applicable.

  • onScrollPrevious () => void

    Callback function for when the user scrolls to the previous element.

  • onScrollNext () => void

    Callback function for when the user scrolls to the next element.

  • canScrollHorizontal boolean

    Whether users can scroll within the overflow container.

    Defaultfalse
  • offset number | string

    A value specifying the distance the scroll should move.

    Default120
  • offsetType 'percentage' | 'fixed'

    Type of offset value (percentage or fixed).

    Default'fixed'
  • gap number

    Specifies inner space between children blocks.

    Valid values are based on the spacing classes: 0, 0.5, ... 6.

    Default3