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#
CSS Variable | Computed Value |
---|---|
| |
| |
| |
| |
| |
Props API#
- className
string
Specifies class name for the ChipCarousel.
- items
Array<React.ReactElement>
RequiredSpecifies array of
Chip
elements to be rendered inside the carousel. - ariaLabel
string
RequiredText 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
DefaultfalseWhether users can scroll within the overflow container.
- offset
number
|string
Default120A value specifying the distance the scroll should move.
- offsetType
'percentage'
|'fixed'
Default'fixed'Type of offset value (percentage or fixed).
- gap
number
Default3Specifies inner space between children blocks.
Valid values are based on
the spacing classes
:0, 0.5, ... 6
.