Interface CarouselProps

Acceptable Carousel properties

Note that some properties are inherited from other sets.

Hierarchy

Properties

adaptiveHeight? afterChange? autoplay? autoplaySpeed? beforeChange? centerMode? draggable? id? infinite? initialSlide? slidesToScroll? slidesToShow? speed? swipe? swipeEvent? transform? transition? variableWidth? visualState?

Properties

Optional adaptiveHeight

adaptiveHeight?: boolean

The component's height adjusts automatically according to the element's height.

Optional afterChange

afterChange?: ((currentSlide) => void)

Type declaration

    • (currentSlide): void

    • Function to be called after slid change

      Parameters

      • currentSlide: number

        current slide index

      Returns void

      nothing

Optional autoplay

autoplay?: boolean

Enables automatic slide transition

Optional autoplaySpeed

autoplaySpeed?: number

Transition Speed

Optional beforeChange

beforeChange?: ((currentSlide, nextSlide) => void)

Type declaration

    • (currentSlide, nextSlide): void

    • Function to be called before slide change

      Parameters

      • currentSlide: number

        slide index number

      • nextSlide: number

        next slid index number

      Returns void

      nothing

Optional centerMode

centerMode?: boolean

Sets centralized mode

Optional draggable

draggable?: boolean

Allows to drag slides

Optional id

id?: string

"Fills the ID of the element (not very practical)."

Example:

 <View id="id" />

Optional infinite

infinite?: boolean

Enables circular rotation of slides

Optional initialSlide

initialSlide?: number

Initial slide number

Optional slidesToScroll

slidesToScroll?: number

Number of slides to be changed

Optional slidesToShow

slidesToShow?: number

number of slides per page to show

Optional speed

speed?: number

Sets slide transition speed

Optional swipe

swipe?: boolean

Enables swipe

Optional swipeEvent

swipeEvent?: ((swipeDirection, event) => void)

Type declaration

    • (swipeDirection, event): void

    • Function to be called when a slide has changed

      Parameters

      • swipeDirection: "left" | "right" | "downLeft" | "upLeft" | "downRight" | "upRight"

        Direction of swipe

      • event: SyntheticEvent<Element, Event>

        swipe event

      Returns void

      nothing

Optional transform

transform?: string

"Prepare a position transforming of element"

Example:

 <View transform="rotate(45deg)" />

Optional transition

transition?: string

"Prepare a transition of visual state change"

Example:

 <View transition="background-color 0.5s ease-in-out" />

Optional variableWidth

variableWidth?: boolean

Sets the slide inner element width to adjust width

Optional visualState

visualState?: "success" | "danger" | "warning"

"Determines the visual state of the component and its children."

Example:

 <View visualState="success" />

Settings

Member Visibility

Theme

On This Page