@types/react-slick

  • Version 0.23.5
  • Published
  • 6.63 kB
  • 1 dependency
  • MIT license

Install

npm i @types/react-slick
yarn add @types/react-slick
pnpm add @types/react-slick

Overview

TypeScript definitions for react-slick

Index

Classes

class Slider

class Slider extends React.Component<Settings, never> {}

    method slickGoTo

    slickGoTo: (slideNumber: number, dontAnimate?: boolean) => void;

      method slickNext

      slickNext: () => void;

        method slickPause

        slickPause: () => void;

          method slickPlay

          slickPlay: () => void;

            method slickPrev

            slickPrev: () => void;

              Interfaces

              interface CustomArrowProps

              interface CustomArrowProps {}

                property className

                className?: string | undefined;

                  property currentSlide

                  currentSlide?: number | undefined;

                    property onClick

                    onClick?: React.MouseEventHandler<any> | undefined;

                      property slideCount

                      slideCount?: number | undefined;

                        property style

                        style?: React.CSSProperties | undefined;

                          interface ResponsiveObject

                          interface ResponsiveObject {}

                            property breakpoint

                            breakpoint: number;

                              property settings

                              settings: 'unslick' | Settings;

                                interface Settings

                                interface Settings {}

                                  property accessibility

                                  accessibility?: boolean | undefined;

                                    property adaptiveHeight

                                    adaptiveHeight?: boolean | undefined;

                                      property arrows

                                      arrows?: boolean | undefined;

                                        property asNavFor

                                        asNavFor?: Slider | undefined;

                                          property autoplay

                                          autoplay?: boolean | undefined;

                                            property autoplaySpeed

                                            autoplaySpeed?: number | undefined;

                                              property centerMode

                                              centerMode?: boolean | undefined;

                                                property centerPadding

                                                centerPadding?: string | undefined;

                                                  property className

                                                  className?: string | undefined;

                                                    property cssEase

                                                    cssEase?: string | undefined;

                                                      property dots

                                                      dots?: boolean | undefined;

                                                        property dotsClass

                                                        dotsClass?: string | undefined;

                                                          property draggable

                                                          draggable?: boolean | undefined;

                                                            property easing

                                                            easing?: string | undefined;

                                                              property edgeFriction

                                                              edgeFriction?: number | undefined;

                                                                property fade

                                                                fade?: boolean | undefined;

                                                                  property focusOnSelect

                                                                  focusOnSelect?: boolean | undefined;

                                                                    property infinite

                                                                    infinite?: boolean | undefined;

                                                                      property initialSlide

                                                                      initialSlide?: number | undefined;

                                                                        property lazyLoad

                                                                        lazyLoad?: LazyLoadTypes | undefined;

                                                                          property nextArrow

                                                                          nextArrow?: JSX.Element | undefined;

                                                                            property pauseOnDotsHover

                                                                            pauseOnDotsHover?: boolean | undefined;

                                                                              property pauseOnFocus

                                                                              pauseOnFocus?: boolean | undefined;

                                                                                property pauseOnHover

                                                                                pauseOnHover?: boolean | undefined;

                                                                                  property prevArrow

                                                                                  prevArrow?: JSX.Element | undefined;

                                                                                    property responsive

                                                                                    responsive?: ResponsiveObject[] | undefined;

                                                                                      property rows

                                                                                      rows?: number | undefined;

                                                                                        property rtl

                                                                                        rtl?: boolean | undefined;

                                                                                          property slide

                                                                                          slide?: string | undefined;

                                                                                            property slidesPerRow

                                                                                            slidesPerRow?: number | undefined;

                                                                                              property slidesToScroll

                                                                                              slidesToScroll?: number | undefined;

                                                                                                property slidesToShow

                                                                                                slidesToShow?: number | undefined;

                                                                                                  property speed

                                                                                                  speed?: number | undefined;

                                                                                                    property swipe

                                                                                                    swipe?: boolean | undefined;

                                                                                                      property swipeToSlide

                                                                                                      swipeToSlide?: boolean | undefined;

                                                                                                        property touchMove

                                                                                                        touchMove?: boolean | undefined;

                                                                                                          property touchThreshold

                                                                                                          touchThreshold?: number | undefined;

                                                                                                            property useCSS

                                                                                                            useCSS?: boolean | undefined;

                                                                                                              property useTransform

                                                                                                              useTransform?: boolean | undefined;

                                                                                                                property variableWidth

                                                                                                                variableWidth?: boolean | undefined;

                                                                                                                  property vertical

                                                                                                                  vertical?: boolean | undefined;

                                                                                                                    property verticalSwiping

                                                                                                                    verticalSwiping?: boolean | undefined;

                                                                                                                      property waitForAnimate

                                                                                                                      waitForAnimate?: boolean | undefined;

                                                                                                                        method afterChange

                                                                                                                        afterChange: (currentSlide: number) => void;

                                                                                                                          method appendDots

                                                                                                                          appendDots: (dots: any) => any;

                                                                                                                            method beforeChange

                                                                                                                            beforeChange: (currentSlide: number, nextSlide: number) => void;

                                                                                                                              method customPaging

                                                                                                                              customPaging: (index: number) => any;

                                                                                                                                method onEdge

                                                                                                                                onEdge: (swipeDirection: SwipeDirection) => void;

                                                                                                                                  method onInit

                                                                                                                                  onInit: () => void;

                                                                                                                                    method onLazyLoad

                                                                                                                                    onLazyLoad: (slidesToLoad: number[]) => void;

                                                                                                                                      method onReInit

                                                                                                                                      onReInit: () => void;

                                                                                                                                        method onSwipe

                                                                                                                                        onSwipe: (swipeDirection: SwipeDirection) => void;

                                                                                                                                          method swipeEvent

                                                                                                                                          swipeEvent: (swipeDirection: SwipeDirection) => void;

                                                                                                                                            Type Aliases

                                                                                                                                            type LazyLoadTypes

                                                                                                                                            type LazyLoadTypes = 'ondemand' | 'progressive';

                                                                                                                                              type SwipeDirection

                                                                                                                                              type SwipeDirection = 'left' | 'down' | 'right' | 'up' | string;

                                                                                                                                                Package Files (1)

                                                                                                                                                Dependencies (1)

                                                                                                                                                Dev Dependencies (0)

                                                                                                                                                No dev dependencies.

                                                                                                                                                Peer Dependencies (0)

                                                                                                                                                No peer dependencies.

                                                                                                                                                Badge

                                                                                                                                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/react-slick.

                                                                                                                                                • Markdown
                                                                                                                                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/react-slick)
                                                                                                                                                • HTML
                                                                                                                                                  <a href="https://www.jsdocs.io/package/@types/react-slick"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>