Add reset method

davidjerleke · Jan 14, 2024 · e6953b6 · e6953b6
1 parent 705da45
commit e6953b6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/packages/embla-carousel-auto-scroll/src/components/AutoScroll.ts b/packages/embla-carousel-auto-scroll/src/components/AutoScroll.ts
@@ -22,6 +22,7 @@ export type AutoScrollType = CreatePluginType<
   {
     play: (delay?: number) => void
     stop: () => void
+    reset: () => void
     isPlaying: () => boolean
   },
   OptionsType
@@ -228,6 +229,13 @@ function AutoScroll(userOptions: AutoScrollOptionsType = {}): AutoScrollType {
     if (playing) stopScroll()
   }
 
+  function reset(): void {
+    if (playing) {
+      stopScroll()
+      startScrollOnSettle()
+    }
+  }
+
   function isPlaying(): boolean {
     return playing
   }
@@ -239,6 +247,7 @@ function AutoScroll(userOptions: AutoScrollOptionsType = {}): AutoScrollType {
     destroy,
     play,
     stop,
+    reset,
     isPlaying
   }
   return self

diff --git a/packages/embla-carousel-docs/src/content/pages/plugins/auto-scroll.mdx b/packages/embla-carousel-docs/src/content/pages/plugins/auto-scroll.mdx
@@ -148,6 +148,15 @@ Stops auto scroll.
 
 ---
 
+### reset
+
+Parameters: <BrandPrimaryText>`none`</BrandPrimaryText>  
+Returns: <BrandSecondaryText>`void`</BrandSecondaryText>
+
+Stops auto scroll and starts over. This will only take effect if auto scroll is playing. If auto scroll is stopped, this method won't trigger anything.
+
+---
+
 ### isPlaying
 
 Parameters: <BrandPrimaryText>`none`</BrandPrimaryText>