Update react-slick types (#25112)

* Update types for react-slick 0.23.1

* Fix tests

* Update react-slick version in comment

* Don't include patch version
This commit is contained in:
melissa-hong
2018-04-24 16:13:52 -07:00
committed by Wesley Wigham
parent d29b31e5db
commit efc15ee34b
2 changed files with 30 additions and 21 deletions

View File

@@ -1,4 +1,4 @@
// Type definitions for react-slick 0.15
// Type definitions for react-slick 0.23
// Project: https://github.com/akiran/react-slick
// Definitions by: Andrey Balokha <https://github.com/andrewBalekha>
// Giedrius Grabauskas <https://github.com/GiedriusGrabauskas>
@@ -27,54 +27,63 @@ export type SwipeDirection = "left" | "down" | "right" | "up" | string;
export interface Settings {
accessibility?: boolean;
className?: string;
adaptiveHeight?: boolean;
afterChange?(currentSlide: number): void;
appendDots?(dots: React.ReactNode): JSX.Element;
arrows?: boolean;
nextArrow?: JSX.Element;
prevArrow?: JSX.Element;
autoplay?: boolean;
asNavFor?: Slider;
autoplaySpeed?: number;
autoplay?: boolean;
beforeChange?(currentSlide: number, nextSlide: number): void;
centerMode?: boolean;
centerPadding?: string;
className?: string;
cssEase?: string;
customPaging?(index: number): JSX.Element;
dots?: boolean;
dotsClass?: string;
dots?: boolean;
draggable?: boolean;
easing?: string;
edgeFriction?: number;
fade?: boolean;
focusOnSelect?: boolean;
infinite?: boolean;
initialSlide?: number;
lazyLoad?: boolean;
lazyLoad?: "ondemand" | "progressive";
nextArrow?: JSX.Element;
onEdge?(swipeDirection: SwipeDirection): void;
onInit?(): void;
onLazyLoad?(slidesToLoad: number[]): void;
onReInit?(): void;
onSwipe?(swipeDirection: SwipeDirection): void;
pauseOnDotsHover?: boolean;
pauseOnFocus?: boolean;
pauseOnHover?: boolean;
prevArrow?: JSX.Element;
responsive?: ResponsiveObject[];
rows?: number;
rtl?: boolean;
slide?: string;
slidesToShow?: number;
slidesPerRow?: number;
slidesToScroll?: number;
slidesToShow?: number;
speed?: number;
swipe?: boolean;
swipeToSlide?: boolean;
swipe?: boolean;
swipeEvent?(swipeDirection: SwipeDirection): void;
touchMove?: boolean;
touchThreshold?: number;
variableWidth?: boolean;
useCSS?: boolean;
useTransform?: boolean;
variableWidth?: boolean;
vertical?: boolean;
afterChange?(currentSlide: number): void;
beforeChange?(currentSlide: number, nextSlide: number): void;
slickGoTo?: number;
edgeFriction?: number;
waitForAnimate?: boolean;
edgeEvent?(swipeDirection: SwipeDirection): void;
swipeEvent?(swipeDirection: SwipeDirection): void;
init?(): void;
}
declare class Slider extends React.Component<Settings, never> {
slickNext(): void;
slickPrev(): void;
slickGoTo(slideNumber: number): void;
slickGoTo(slideNumber: number, dontAnimate?: boolean): void;
}
export default Slider;

View File

@@ -40,7 +40,7 @@ const defaultSettings: Settings = {
focusOnSelect: false,
infinite: true,
initialSlide: 0,
lazyLoad: false,
lazyLoad: "progressive",
pauseOnHover: true,
responsive: [{ breakpoint: 1000, settings: "unslick" }, { breakpoint: 2000, settings: { arrows: false } }],
rtl: false,
@@ -58,8 +58,8 @@ const defaultSettings: Settings = {
waitForAnimate: true,
afterChange: (currentSlide: number) => { },
beforeChange: (currentSlide: number, nextSlide: number) => { },
edgeEvent: (swipeDirection: string) => { },
init: () => { },
onEdge: (swipeDirection: string) => { },
onInit: () => { },
swipeEvent: (swipeDirection: string) => { },
nextArrow: <LeftNavArrow />,
prevArrow: <RightNavArrow />