ChipCarousel
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 (SCSS)#
$chip-carousel-controls-top-offset: -3px !default;
Props API#
- ariaLabel
stringRequiredText describing the ChipCarousel for screen readers.
- className
stringSpecifies class name for the ChipCarousel.
- items
element[]RequiredSpecifies array of
Chipelements to be rendered inside the carousel. - disableOpacityMasks
boolWhether the default opacity masks should be shown at the start/end, if applicable.
- onScrollPrevious
funcCallback function for when the user scrolls to the previous element.
- onScrollNext
funcCallback function for when the user scrolls to the next element.
- canScrollHorizontal
boolDefaultfalseWhether users can scroll within the overflow container.
- offset
number|stringDefault120A value specifying the distance the scroll should move.
- offsetType
enum'percentage' | 'fixed'Default'fixed'Type of offset value (percentage or fixed).
- gap
numberDefault3Specifies inner space between children blocks.
Valid values are based on
the spacing classes:0, 0.5, ... 6.