Carousel: Fix autoplay and enable callback on autoplay index change #33291
+226
−162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fabricteam
reviewed
Nov 18, 2024
🕵 fluentui-web-components-v3 No visual regressions between this PR and main |
🕵 FluentUIV0 No visual regressions between this PR and main |
📊 Bundle size report
Unchanged fixtures
|
fabricteam
reviewed
Nov 18, 2024
Mitch-At-Work
force-pushed
the
user/mifraser/enable-autoplay-callback
branch
from
f1af038
to
f427173
Compare
|
Pull request demo site: URL |
packages/react-components/react-carousel/stories/src/Carousel/CarouselActionCards.stories.tsx
Outdated
Show resolved
Hide resolved
packages/react-components/react-carousel/stories/src/Carousel/CarouselEventing.stories.tsx
Outdated
Show resolved
Hide resolved
packages/react-components/react-carousel/library/src/components/useEmblaCarousel.ts
Outdated
Show resolved
Hide resolved
packages/react-components/react-carousel/library/src/components/useEmblaCarousel.ts
Outdated
Show resolved
Hide resolved
packages/react-components/react-carousel/library/src/components/useEmblaCarousel.ts
Outdated
Show resolved
Hide resolved
packages/react-components/react-carousel/library/src/components/useEmblaCarousel.ts
Outdated
Show resolved
Hide resolved
| @@ -142,22 +189,27 @@ export function useEmblaCarousel( | |||
| } | |||
| }); | |||
|
|
|||
| const handleIndexChange = React.useCallback(() => { | |||
There was a problem hiding this comment.
type EmblaEventHandler = Parameters<EmblaCarouselType['on']>[1];
// ...
and then we can do:
const handleIndexChange: EmblaEventHandler = useEventCallback((_, eventType) => {
const newIndex = emblaApi.current?.selectedScrollSnap() ?? 0;
const slides = emblaApi.current?.slideNodes();
const actualIndex = emblaApi.current?.internalEngine().slideRegistry[newIndex][0] ?? 0;
// We set the active or first index of group on-screen as the selected tabster index
slides?.forEach((slide, slideIndex) => {
setTabsterDefault(slide, slideIndex === actualIndex);
});
setActiveIndex(newIndex);
if (eventType === 'autoplay:select') {
onAutoplayIndexChange?.(null, { event: null, type: 'autoplay', index: newIndex });
}
});
🐱
packages/react-components/react-carousel/library/etc/react-carousel.api.md
Outdated
Show resolved
Hide resolved
dmytrokirpa
approved these changes
Nov 27, 2024
Comment on lines
+122
to
+138
| const enableAutoplay = React.useCallback( | ||
| (_autoplay: boolean, temporary?: boolean) => { | ||
| if (!temporary) { | ||
| autoplayRef.current = _autoplay; | ||
| } | ||
|
|
||
| if (_autoplay && autoplayRef.current) { | ||
| // Autoplay should only enable in the case where underlying state is true, temporary should not override | ||
| emblaApi.current?.plugins().autoplay?.play(); | ||
| // Reset after play to ensure timing and any focus/mouse pause state is reset. | ||
| resetAutoplay(); | ||
| } else if (!_autoplay) { | ||
| emblaApi.current?.plugins().autoplay?.stop(); | ||
| } | ||
| }, | ||
| [resetAutoplay], | ||
| ); |
There was a problem hiding this comment.
Suggested change
| const enableAutoplay = React.useCallback( | |
| (_autoplay: boolean, temporary?: boolean) => { | |
| if (!temporary) { | |
| autoplayRef.current = _autoplay; | |
| } | |
| if (_autoplay && autoplayRef.current) { | |
| // Autoplay should only enable in the case where underlying state is true, temporary should not override | |
| emblaApi.current?.plugins().autoplay?.play(); | |
| // Reset after play to ensure timing and any focus/mouse pause state is reset. | |
| resetAutoplay(); | |
| } else if (!_autoplay) { | |
| emblaApi.current?.plugins().autoplay?.stop(); | |
| } | |
| }, | |
| [resetAutoplay], | |
| ); | |
| const enableAutoplay = React.useCallback( | |
| (autoplay: boolean, temporary?: boolean) => { | |
| if (!temporary) { | |
| autoplayRef.current = autoplay; | |
| } | |
| if (autoplay && autoplayRef.current) { | |
| // Autoplay should only enable in the case where underlying state is true, temporary should not override | |
| emblaApi.current?.plugins().autoplay?.play(); | |
| // Reset after play to ensure timing and any focus/mouse pause state is reset. | |
| resetAutoplay(); | |
| } else if (!autoplay) { | |
| emblaApi.current?.plugins().autoplay?.stop(); | |
| } | |
| }, | |
| [resetAutoplay], | |
| ); |
nit: we don't need _ after the latest changes 🐱
Comment on lines
+180
to
+181
| const _event = new Event('autoplay'); | ||
| onAutoplayIndexChange?.(_event, { event: _event, type: 'autoplay', index: newIndex }); |
There was a problem hiding this comment.
Suggested change
| const _event = new Event('autoplay'); | |
| onAutoplayIndexChange?.(_event, { event: _event, type: 'autoplay', index: newIndex }); | |
| // There is no event object for autoplay as there is no a DOM event | |
| const noopEvent = new Event('autoplay'); | |
| onAutoplayIndexChange?.(noopEvent, { event: noopEvent, type: 'autoplay', index: newIndex }); |
layershifter
approved these changes
Nov 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previous Behavior
No autoplay callback making controlled scenarios not usable with autoplay.
Autoplay would start with 'stopOnInteraction' based on its autoplay value, this caused three issues:
New Behavior
Autoplay callback enables controlled autoplay callbacks
Autoplay will now be attached always, but conditionally enabled by stop/start calls, removing need for a reinitialize of carousel
Autoplay logic can be paused/resumed without overriding play button state for temporary interaction pauses like focus or mouse hover