HorizontalScroll
Groups items onto one accessible row even on small screens.
HorizontalScroll
To implement HorizontalScroll component into your project you’ll need to add the import:
import HorizontalScroll from "@kiwicom/orbit-components/lib/HorizontalScroll";
After adding import into your project you can use it simply like:
<HorizontalScroll><FirstComponent /><SecondComponent /><ThirdComponent />...etc</HorizontalScroll>
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| minHeight | number | set minimal height | ||
| dataTest | string | prop for testing purposes | ||
| id | string | Set id for HorizontalScroll | ||
| spacing | Spacing | “small” | the spacing between children elements | |
| children | React.ReactNode | :heavy_check_mark: | content of HorizontalScroll | |
| scrollSnap | ScrollSnap | “none” | set value for scroll-snap-type property | |
| scrollPadding | number | set value for scroll-padding property | ||
| overflowElevation | boolean | set box-shadow on sides during scroll | ||
| elevationColor | string | paletteCloudDarker | set box-shadow color | |
| onOverflow | () => void | callback function, fires, if content is overflowed |
ScrollSnap
| ScrollSnap |
|---|
"mandatory" |
"proximity" |
"inline" |
"none" |
Spacing
| Spacing |
|---|
"none" |
"XXXSmall" |
"XXSmall" |
"XSmall" |
"small" |
"medium" |
"large" |
"XLarge" |
"XXLarge" |