nuka-carousel - npm Package Compare versions

Comparing version 5.0.11 to 5.0.12

index.d.ts

@@ -1,5 +0,1 @@
-// Definitions by: Roman Charugin <https://github.com/Romic>
-//                 Alex Smith <https://github.com/altaudio>
-//                 matt-sungwook <https://github.com/matt-sungwook>
-
 import * as React from 'react';
@@ -11,6 +7,2 @@
 
-export type CarouselHeightModeProp = 'first' | 'current' | 'max';
-
-export type CarouselTransitionModeProp = 'fade' | 'scroll' | 'scroll3d';
-
 export type CarouselSlidesToScrollProp = number | 'auto';
@@ -107,2 +99,7 @@
   /**
+   * If it's set to true, the carousel will adapt its height to the visible slides.
+   */
+  adaptiveHeight?: boolean;
+
+  /**
    * Hook to be called after a slide is changed
@@ -114,13 +111,7 @@ * @param index Index of the current slide
   /**
-   * Adds a zoom effect on the currently visible slide.
+   * Adds a zoom or fade effect on the currently visible slide.
    */
-  animation?: 'zoom';
+  animation?: 'zoom' | 'fade';
 
   /**
-   * Will generate a style tag to help ensure images are displayed properly
-   * @default true
-   */
-  autoGenerateStyleTag?: boolean;
-
-  /**
    * Autoplay mode active
@@ -167,22 +158,2 @@ * @default false
   /**
-   * When set to true, disable keyboard controls
-   * @default false
-   */
-  enableKeyboardControls?: boolean;
-
-  /**
-   * When enableKeyboardControls is enabled, Configure keyCodes for corresponding slide actions as array of keyCodes
-   */
-  keyCodeConfig?: {
-    [slideAction in CarouselSlideActions]?: number[];
-  };
-
-  /**
-   * Optional callback to apply styles to the container of a control.
-   */
-  getControlsContainerStyles?: (
-    key: CarouselControlContainerProp
-  ) => React.CSSProperties;
-
-  /**
    * This prop lets you apply custom classes and styles to the default Next, Previous, and Paging Dots controls
@@ -233,23 +204,13 @@ */
   /**
-   * Used to set overflow style property on slider frame
-   * @default 'hidden'
+   * When set to true, disable keyboard controls
+   * @default false
    */
-  frameOverflow?: string;
+  enableKeyboardControls?: boolean;
 
   /**
-   * Used to set the margin of the slider frame.
-   * Accepts any string dimension value such as "0px 20px" or "500px"
-   * @example '0px 20px'
-   * @example '500px'
+   * Customize the aria-label of the frame container of the carousel. This is useful when you have more than one carousel on the page.
    */
-  framePadding?: string;
+  frameAriaLabel?: string;
 
   /**
-   * Used to hardcode the slider height
-   * @example '80%'
-   * @example '500px'
-   */
-  height?: string;
-
-  /**
    * Ref to pass to carousel element
@@ -260,16 +221,21 @@ */
   /**
-   * Change the height of the slides based either on the first slide,
-   * the current slide, or the maximum height of all slides.
+   * When enableKeyboardControls is enabled, Configure keyCodes for corresponding slide actions as array of keyCodes
    */
-  heightMode?: CarouselHeightModeProp;
+  keyCodeConfig?: {
+    [slideAction in CarouselSlideActions]?: number[];
+  };
 
   /**
-   * Initial height of the slides (px)
+   * optional callback function
    */
-  initialSlideHeight?: number;
+  onDragStart?: (
+    e?: React.TouchEvent<HTMLDivElement> | React.MouseEvent<HTMLDivElement>
+  ) => void;
 
   /**
-   * Initial width of the slides (px)
+   * optional callback function
    */
-  initialSlideWidth?: number;
+  onDrag?: (
+    e?: React.TouchEvent<HTMLDivElement> | React.MouseEvent<HTMLDivElement>
+  ) => void;
 
@@ -279,16 +245,7 @@ /**
    */
-  onDragStart?: (e?: Event) => void;
+  onDragEnd?: (
+    e?: React.TouchEvent<HTMLDivElement> | React.MouseEvent<HTMLDivElement>
+  ) => void;
 
   /**
-   * Window onResize callback
-   */
-  onResize?: () => void;
-
-  /**
-   * Adds a number value to set the scale of the opacity for the 'scroll3d' transition mode.
-   * @default 0.65
-   */
-  opacityScale?: number;
-
-  /**
    * Pause autoPlay when mouse is over carousel
@@ -364,11 +321,4 @@ * @default true
   /**
-   * While using prop animation = "zoom", you can
-   * configure space around current slide with slideOffset.
+   * Slides to scroll at once.
    */
-  slideOffset?: number;
-
-  /**
-   * Slides to scroll at once. Set to "auto"
-   * to always scroll the current number of visible slides
-   */
   slidesToScroll?: CarouselSlidesToScrollProp;
@@ -382,9 +332,2 @@
   /**
-   * Manually set slideWidth
-   * @example '20px'
-   * @example 0.8
-   */
-  slideWidth?: CarouselSlideWidthProp;
-
-  /**
    * Animation duration
@@ -405,7 +348,2 @@ */
   /**
-   * Set the way slides transition from one to the next
-   */
-  transitionMode?: CarouselTransitionModeProp;
-
-  /**
    * Enable the slides to transition vertically
@@ -416,9 +354,2 @@ */
   /**
-   * Used to hardcode the slider width
-   * @example '80%'
-   * @example '500px'
-   */
-  width?: string;
-
-  /**
    * Sets infinite wrapAround mode
@@ -459,14 +390,4 @@ * @default false
 
-  /**
-   * Current frame width
-   */
-  frameWidth: number;
-
   isWrappingAround: boolean;
 
-  /**
-   * Current left value
-   */
-  left: number;
-
   pauseOnHover: boolean;
@@ -492,7 +413,2 @@
   /**
-   * Current top value
-   */
-  top: number;
-
-  /**
    * Is infinite mode enabled
@@ -499,0 +415,0 @@ */

package.json

 {
   "name": "nuka-carousel",
-  "version": "5.0.11",
+  "version": "5.0.12",
   "description": "Pure React Carousel",
@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

128218

decreased by-1.31%

Lines of code

2629

decreased by-2.52%

No dependency changes