feat: carousel: adds size overlaycontrols and button props

dkilgore-eightfold commented 5 months ago

SUMMARY:

Adds size prop and its enum CarouselSize Large, Medium and Small, for now it only effects the buttons and their masks sizes, but may scale to effect other things in the future
Updates Button implementation to use variant prop
Adds nextButtonProps and previousButtonProps to support even greater customization possibilities
Handles scroll event spamming
Adds overlayControls prop with a default value of true, enabling an option to either overlay the next/previous buttons or move them to either side of the scrollable list (Applicable to type of scroll only).
Simplifies single scroll distance logic
Adds UTs
Updates stories

https://github.com/EightfoldAI/octuple/assets/99700808/b334a8ef-a672-4ada-8bab-9ec91f1cbe67

JIRA TASK (Eightfold Employees Only):

ENG-75830

CHANGE TYPE:

[ ] Bugfix Pull Request
[x] Feature Pull Request

TEST COVERAGE:

[ ] Tests for this change already exist
[x] I have added unittests for this change

TEST PLAN:

Pull the PR branch and run yarn and yarn storybook. Verify the Carousel stories behave as expected.

codesandbox-ci[bot] commented 5 months ago

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 2f2e524c5cc8797de771aa6ba234e06cc931520c:

Sandbox	Source
React	Configuration

codecov[bot] commented 5 months ago

Codecov Report

Attention: 69 lines in your changes are missing coverage. Please review.

Comparison is base (e0b8f12) 84.86% compared to head (2f2e524) 84.87%.

Files	Patch %	Lines
src/components/Carousel/Carousel.tsx	39.47%	69 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #774 +/- ## ======================================= Coverage 84.86% 84.87% ======================================= Files 999 999 Lines 19418 19496 +78 Branches 7228 7258 +30 ======================================= + Hits 16479 16547 +68 - Misses 2857 2869 +12 + Partials 82 80 -2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

EightfoldAI / octuple