Interface CarouselProps

interface CarouselProps {
    accessibility?: boolean;
    adaptiveHeight?: boolean;
    arrows?: boolean;
    asNavFor?: Slider;
    autoplay?: boolean;
    autoplaySpeed?: number;
    centerMode?: boolean;
    centerPadding?: string;
    className?: string;
    controller?: boolean;
    controllerRender?: ((current, total, prev, next, autoPlay, toggleAutoPlay, showAll) => ReactNode);
    cssEase?: string;
    data?: CarouselData[];
    defaultShowAll?: boolean;
    dotPosition?: DotPosition;
    dots?: boolean | {
        className?: string;
    };
    draggable?: boolean;
    easing?: string;
    edgeFriction?: number;
    effect?: CarouselEffect;
    emptyDescription?: string;
    fade?: boolean;
    focusOnSelect?: boolean;
    id?: string;
    infinite?: boolean;
    initialSlide?: number;
    isLoading?: boolean;
    lazyLoad?: LazyLoadTypes;
    leftArrowColor?: DevfiveColorKey;
    nextArrow?: ReactNode;
    pauseOnDotsHover?: boolean;
    pauseOnFocus?: boolean;
    pauseOnHover?: boolean;
    prefixCls?: string;
    prevArrow?: ReactNode;
    responsive?: ResponsiveObject[];
    rightArrowColor?: DevfiveColorKey;
    rootClassName?: string;
    rows?: number;
    rtl?: boolean;
    showAll?: boolean;
    showAutoplayToggle?: boolean;
    slickGoTo?: number;
    slide?: string;
    slidesPerRow?: number;
    slidesToScroll?: number;
    slidesToShow?: number;
    speed?: number;
    style?: CSSProperties;
    swipe?: boolean;
    swipeToSlide?: boolean;
    touchMove?: boolean;
    touchThreshold?: number;
    useCSS?: boolean;
    useTransform?: boolean;
    variableWidth?: boolean;
    vertical?: boolean;
    verticalSwiping?: boolean;
    waitForAnimate?: boolean;
    afterChange?(currentSlide): void;
    appendDots?(dots): Element;
    beforeChange?(currentSlide, nextSlide): void;
    customPaging?(index): Element;
    onEdge?(swipeDirection): void;
    onInit?(): void;
    onLazyLoad?(slidesToLoad): void;
    onReInit?(): void;
    onSwipe?(swipeDirection): void;
    swipeEvent?(swipeDirection): void;
}

Hierarchy

Properties

accessibility? adaptiveHeight? arrows? asNavFor? autoplay? autoplaySpeed? centerMode? centerPadding? className? controller? controllerRender? cssEase? data? defaultShowAll? dotPosition? dots? draggable? easing? edgeFriction? effect? emptyDescription? fade? focusOnSelect? id? infinite? initialSlide? isLoading? lazyLoad? leftArrowColor? nextArrow? pauseOnDotsHover? pauseOnFocus? pauseOnHover? prefixCls? prevArrow? responsive? rightArrowColor? rootClassName? rows? rtl? showAll? showAutoplayToggle? slickGoTo? slide? slidesPerRow? slidesToScroll? slidesToShow? speed? style? swipe? swipeToSlide? touchMove? touchThreshold? useCSS? useTransform? variableWidth? vertical? verticalSwiping? waitForAnimate?

Methods

afterChange? appendDots? beforeChange? customPaging? onEdge? onInit? onLazyLoad? onReInit? onSwipe? swipeEvent?

Properties

Optional accessibility

accessibility?: boolean

Optional adaptiveHeight

adaptiveHeight?: boolean

Optional arrows

arrows?: boolean

Optional asNavFor

asNavFor?: Slider

Optional autoplay

autoplay?: boolean

Optional autoplaySpeed

autoplaySpeed?: number

Optional centerMode

centerMode?: boolean

Optional centerPadding

centerPadding?: string

Optional className

className?: string

Optional controller

controller?: boolean

Optional controllerRender

controllerRender?: ((current, total, prev, next, autoPlay, toggleAutoPlay, showAll) => ReactNode)

Type declaration

    • (current, total, prev, next, autoPlay, toggleAutoPlay, showAll): ReactNode

    • Parameters

      • current: number
      • total: number
      • prev: (() => void)
          • (): void

          • Returns void

      • next: (() => void)
          • (): void

          • Returns void

      • autoPlay: boolean
      • toggleAutoPlay: ((status) => void)
          • (status): void

          • Parameters

            • status: boolean

            Returns void

      • showAll: (() => void)
          • (): void

          • Returns void

      Returns ReactNode

Optional cssEase

cssEase?: string

Optional data

data?: CarouselData[]

Optional defaultShowAll

defaultShowAll?: boolean

Optional dotPosition

dotPosition?: DotPosition

Optional dots

dots?: boolean | {
    className?: string;
}

Type declaration

  • Optional className?: string

Optional draggable

draggable?: boolean

Optional easing

easing?: string

Optional edgeFriction

edgeFriction?: number

Optional effect

effect?: CarouselEffect

Optional emptyDescription

emptyDescription?: string

Optional fade

fade?: boolean

Optional focusOnSelect

focusOnSelect?: boolean

Optional id

id?: string

Optional infinite

infinite?: boolean

Optional initialSlide

initialSlide?: number

Optional isLoading

isLoading?: boolean

Optional lazyLoad

lazyLoad?: LazyLoadTypes

Optional leftArrowColor

leftArrowColor?: DevfiveColorKey

Optional nextArrow

nextArrow?: ReactNode

Optional pauseOnDotsHover

pauseOnDotsHover?: boolean

Optional pauseOnFocus

pauseOnFocus?: boolean

Optional pauseOnHover

pauseOnHover?: boolean

Optional prefixCls

prefixCls?: string

Optional prevArrow

prevArrow?: ReactNode

Optional responsive

responsive?: ResponsiveObject[]

Optional rightArrowColor

rightArrowColor?: DevfiveColorKey

Optional rootClassName

rootClassName?: string

Optional rows

rows?: number

Optional rtl

rtl?: boolean

Optional showAll

showAll?: boolean

Optional showAutoplayToggle

showAutoplayToggle?: boolean

Optional slickGoTo

slickGoTo?: number

Optional slide

slide?: string

Optional slidesPerRow

slidesPerRow?: number

Optional slidesToScroll

slidesToScroll?: number

Optional slidesToShow

slidesToShow?: number

Optional speed

speed?: number

Optional style

style?: CSSProperties

Optional swipe

swipe?: boolean

Optional swipeToSlide

swipeToSlide?: boolean

Optional touchMove

touchMove?: boolean

Optional touchThreshold

touchThreshold?: number

Optional useCSS

useCSS?: boolean

Optional useTransform

useTransform?: boolean

Optional variableWidth

variableWidth?: boolean

Optional vertical

vertical?: boolean

Optional verticalSwiping

verticalSwiping?: boolean

Optional waitForAnimate

waitForAnimate?: boolean

Methods

Optional afterChange

  • afterChange(currentSlide): void

  • Parameters

    • currentSlide: number

    Returns void

Optional appendDots

  • appendDots(dots): Element

  • Parameters

    • dots: ReactNode

    Returns Element

Optional beforeChange

  • beforeChange(currentSlide, nextSlide): void

  • Parameters

    • currentSlide: number
    • nextSlide: number

    Returns void

Optional customPaging

  • customPaging(index): Element

  • Parameters

    • index: number

    Returns Element

Optional onEdge

  • onEdge(swipeDirection): void

  • Parameters

    • swipeDirection: string

    Returns void

Optional onInit

  • onInit(): void

  • Returns void

Optional onLazyLoad

  • onLazyLoad(slidesToLoad): void

  • Parameters

    • slidesToLoad: number[]

    Returns void

Optional onReInit

  • onReInit(): void

  • Returns void

Optional onSwipe

  • onSwipe(swipeDirection): void

  • Parameters

    • swipeDirection: string

    Returns void

Optional swipeEvent

  • swipeEvent(swipeDirection): void

  • Parameters

    • swipeDirection: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc