Merge pull request #1054 from Mitch-At-Work/autoplay-triggered-event

[Feat]: Trigger event (autoplay:select) on autoplay index update
davidjerleke · Nov 8, 2024 · e714441 · e714441
2 parents 67a1ac0 + 71a5d47
commit e714441
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/packages/embla-carousel-autoplay/src/components/Autoplay.ts b/packages/embla-carousel-autoplay/src/components/Autoplay.ts
@@ -13,6 +13,7 @@ declare module 'embla-carousel' {
   interface EmblaEventListType {
     autoplayPlay: 'autoplay:play'
     autoplayStop: 'autoplay:stop'
+    autoplaySelect: 'autoplay:select'
   }
 }
 
@@ -165,6 +166,8 @@ function Autoplay(userOptions: AutoplayOptionsType = {}): AutoplayType {
     } else {
       emblaApi.scrollTo(0, jump)
     }
+
+    emblaApi.emit('autoplay:select')
   }
 
   const self: AutoplayType = {

diff --git a/packages/embla-carousel-docs/src/content/pages/plugins/autoplay.mdx b/packages/embla-carousel-docs/src/content/pages/plugins/autoplay.mdx
@@ -193,3 +193,11 @@ Once: <BrandPrimaryText>`no`</BrandPrimaryText>
 Fires when autoplay stops playing.
 
 ---
+
+### autoplay:select
+
+Once: <BrandPrimaryText>`no`</BrandPrimaryText>
+
+Fires directly after autoplay selects a new index.
+
+---