-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
Carousel.tsx
362 lines (307 loc) · 10.6 KB
/
Carousel.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
/* eslint-disable react/no-unused-prop-types */
import React, { forwardRef, useEffect, useCallback, useState, Children } from 'react';
import {
useComponentDefaultProps,
Box,
DefaultProps,
UnstyledButton,
ChevronIcon,
MantineNumberSize,
StylesApiProvider,
Selectors,
} from '@mantine/core';
import { clamp } from '@mantine/hooks';
import useEmblaCarousel, { EmblaPluginType } from 'embla-carousel-react';
import { ForwardRefWithStaticComponents } from '@mantine/utils';
import { CarouselSlide, CarouselSlideStylesNames } from './CarouselSlide/CarouselSlide';
import { CarouselProvider } from './Carousel.context';
import { CarouselOrientation, Embla, CarouselBreakpoint } from './types';
import { getChevronRotation } from './get-chevron-rotation';
import useStyles, { CarouselStylesParams } from './Carousel.styles';
export type CarouselStylesNames = CarouselSlideStylesNames | Selectors<typeof useStyles>;
export interface CarouselProps
extends DefaultProps<CarouselStylesNames, CarouselStylesParams>,
React.ComponentPropsWithRef<'div'> {
/** <Carousel.Slide /> components */
children?: React.ReactNode;
/** Called when user clicks next button */
onNextSlide?(): void;
/** Called when user clicks previous button */
onPreviousSlide?(): void;
/** Called with slide index when slide changes */
onSlideChange?(index: number): void;
/** Get embla API as ref */
getEmblaApi?(embla: Embla): void;
/** Next control aria-label */
nextControlLabel?: string;
/** Previous control aria-label */
previousControlLabel?: string;
/** Previous/next controls size in px */
controlSize?: number;
/** Key of theme.spacing or number to set space between next/previous control and carousel boundary */
controlsOffset?: MantineNumberSize;
/** Slide width, defaults to 100%, examples: 200px, 50% */
slideSize?: string | number;
/** Key of theme.spacing or number to set gap between slides in px */
slideGap?: MantineNumberSize;
/** Control slideSize and slideGap at different viewport sizes */
breakpoints?: CarouselBreakpoint[];
/** Carousel orientation, horizontal by default */
orientation?: CarouselOrientation;
/** Slides container height, required for vertical orientation */
height?: React.CSSProperties['height'];
/** Determines how slides will be aligned relative to the container. Use number between 0-1 to align slides based on percentage, where 0.5 equals 50% */
align?: 'start' | 'center' | 'end' | number;
/** Number of slides that should be scrolled with next/previous buttons */
slidesToScroll?: number | 'auto';
/** Determines whether gap should be treated as part of the slide size, true by default */
includeGapInSize?: boolean;
/** Determines whether carousel can be scrolled with mouse and touch interactions, true by default */
draggable?: boolean;
/** Determines whether momentum scrolling should be enabled, false by default */
dragFree?: boolean;
/** Enables infinite looping. Automatically falls back to false if slide content isn't enough to loop. */
loop?: boolean;
/** Adjusts scroll speed when triggered by any of the methods. Higher numbers enables faster scrolling. */
speed?: number;
/** Index of initial slide */
initialSlide?: number;
/** Choose a fraction representing the percentage portion of a slide that needs to be visible in order to be considered in view. For example, 0.5 equals 50%. */
inViewThreshold?: number;
/** Determines whether next/previous controls should be displayed, true by default */
withControls?: boolean;
/** Determines whether indicators should be displayed, false by default */
withIndicators?: boolean;
/** An array of embla plugins */
plugins?: EmblaPluginType[];
/** Icon of next control */
nextControlIcon?: React.ReactNode;
/** Previous control icon */
previousControlIcon?: React.ReactNode;
/** Allow the carousel to skip scroll snaps if it's dragged vigorously. Note that this option will be ignored if the dragFree option is set to true, false by default */
skipSnaps?: boolean;
/** Clear leading and trailing empty space that causes excessive scrolling. Use trimSnaps to only use snap points that trigger scrolling or keepSnaps to keep them. */
containScroll?: 'trimSnaps' | 'keepSnaps' | '';
/** Determines whether arrow key should switch slides, true by default */
withKeyboardEvents?: boolean;
}
const defaultProps: Partial<CarouselProps> = {
controlSize: 26,
controlsOffset: 'sm',
slideSize: '100%',
slideGap: 0,
orientation: 'horizontal',
align: 'center',
slidesToScroll: 1,
includeGapInSize: true,
draggable: true,
dragFree: false,
loop: false,
speed: 10,
initialSlide: 0,
inViewThreshold: 0,
withControls: true,
withIndicators: false,
skipSnaps: false,
containScroll: '',
withKeyboardEvents: true,
};
export const _Carousel = forwardRef<HTMLDivElement, CarouselProps>((props, ref) => {
const {
children,
className,
getEmblaApi,
onNextSlide,
onPreviousSlide,
onSlideChange,
nextControlLabel,
previousControlLabel,
controlSize,
controlsOffset,
classNames,
styles,
unstyled,
slideSize,
slideGap,
orientation,
height,
align,
slidesToScroll,
includeGapInSize,
draggable,
dragFree,
loop,
speed,
initialSlide,
inViewThreshold,
withControls,
withIndicators,
plugins,
nextControlIcon,
previousControlIcon,
breakpoints,
skipSnaps,
containScroll,
withKeyboardEvents,
...others
} = useComponentDefaultProps('Carousel', defaultProps, props);
const { classes, cx, theme } = useStyles(
{ controlSize, controlsOffset, orientation, height, includeGapInSize, breakpoints, slideGap },
{ name: 'Carousel', classNames, styles, unstyled }
);
const [emblaRefElement, embla] = useEmblaCarousel(
{
axis: orientation === 'horizontal' ? 'x' : 'y',
direction: theme.dir,
startIndex: initialSlide,
loop,
align,
slidesToScroll,
draggable,
dragFree,
speed,
inViewThreshold,
skipSnaps,
containScroll,
},
plugins
);
const [selected, setSelected] = useState(0);
const [slidesCount, setSlidesCount] = useState(0);
const handleScroll = useCallback((index: number) => embla && embla.scrollTo(index), [embla]);
const handleSelect = useCallback(() => {
if (!embla) return;
const slide = embla.selectedScrollSnap();
setSelected(slide);
onSlideChange?.(slide);
}, [embla, setSelected]);
const handlePrevious = useCallback(() => {
embla?.scrollPrev();
onPreviousSlide?.();
}, [embla]);
const handleNext = useCallback(() => {
embla?.scrollNext();
onNextSlide?.();
}, [embla]);
const handleKeydown = useCallback(
(event: React.KeyboardEvent<HTMLDivElement>) => {
if (withKeyboardEvents) {
if (event.key === 'ArrowRight') {
event.preventDefault();
handleNext();
}
if (event.key === 'ArrowLeft') {
event.preventDefault();
handlePrevious();
}
}
},
[embla]
);
useEffect(() => {
if (embla) {
getEmblaApi?.(embla);
handleSelect();
setSlidesCount(embla.scrollSnapList().length);
embla.on('select', handleSelect);
return () => {
embla.off('select', handleSelect);
};
}
return undefined;
}, [embla, slidesToScroll]);
useEffect(() => {
if (embla) {
embla.reInit();
setSlidesCount(embla.scrollSnapList().length);
setSelected((currentSelected) =>
clamp(currentSelected, 0, Children.toArray(children).length - 1)
);
}
}, [Children.toArray(children).length, slidesToScroll]);
const canScrollPrev = embla?.canScrollPrev() || false;
const canScrollNext = embla?.canScrollNext() || false;
const indicators = Array(slidesCount)
.fill(0)
.map((_, index) => (
<UnstyledButton
key={index}
data-active={index === selected || undefined}
className={classes.indicator}
aria-hidden
tabIndex={-1}
onClick={() => handleScroll(index)}
/>
));
return (
<StylesApiProvider classNames={classNames} styles={styles} unstyled={unstyled}>
<CarouselProvider
value={{ slideGap, slideSize, embla, orientation, includeGapInSize, breakpoints }}
>
<Box
className={cx(classes.root, className)}
ref={ref}
onKeyDownCapture={handleKeydown}
{...others}
>
<div className={classes.viewport} ref={emblaRefElement}>
<div className={classes.container}>{children}</div>
</div>
{withIndicators && <div className={classes.indicators}>{indicators}</div>}
{withControls && (
<div className={classes.controls}>
<UnstyledButton
onClick={handlePrevious}
className={classes.control}
aria-label={previousControlLabel}
data-inactive={!canScrollPrev || undefined}
tabIndex={canScrollPrev ? 0 : -1}
>
{typeof previousControlIcon !== 'undefined' ? (
previousControlIcon
) : (
<ChevronIcon
style={{
transform: `rotate(${getChevronRotation({
dir: theme.dir,
orientation,
direction: 'previous',
})}deg)`,
}}
/>
)}
</UnstyledButton>
<UnstyledButton
onClick={handleNext}
className={classes.control}
aria-label={nextControlLabel}
data-inactive={!canScrollNext || undefined}
tabIndex={canScrollNext ? 0 : -1}
>
{typeof nextControlIcon !== 'undefined' ? (
nextControlIcon
) : (
<ChevronIcon
style={{
transform: `rotate(${getChevronRotation({
dir: theme.dir,
orientation,
direction: 'next',
})}deg)`,
}}
/>
)}
</UnstyledButton>
</div>
)}
</Box>
</CarouselProvider>
</StylesApiProvider>
);
}) as any;
_Carousel.Slide = CarouselSlide;
_Carousel.displayName = '@mantine/carousel/Carousel';
export const Carousel: ForwardRefWithStaticComponents<
CarouselProps,
{ Slide: typeof CarouselSlide }
> = _Carousel;