Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrCarouselProps

Hierarchy

Hierarchy

  • IIgrCarouselProps

Properties

Properties

Optional animationType

animationType?: string | HorizontalTransitionAnimation

The animation type.

Optional children

children?: ReactNode

Optional className

className?: string

Optional disableLoop

disableLoop?: string | boolean

Whether the carousel should skip rotating to the first slide after it reaches the last.

Optional disablePauseOnInteraction

disablePauseOnInteraction?: string | boolean

Whether the carousel should ignore use interactions and not pause on them.

Optional hideIndicators

hideIndicators?: string | boolean

Whether the carousel should render the indicator controls (dots).

Optional hideNavigation

hideNavigation?: string | boolean

Whether the carousel should skip rendering of the default navigation buttons.

Optional id

id?: string

Optional indicatorsLabelFormat

indicatorsLabelFormat?: string

The format used to set the aria-label on the carousel indicators. Instances of '{0}' will be replaced with the index of the corresponding slide.

Optional indicatorsOrientation

indicatorsOrientation?: string | CarouselIndicatorsOrientation

Sets the orientation of the indicator controls (dots).

Optional interval

interval?: string | number

The duration in milliseconds between changing the active slide.

Optional maximumIndicatorsCount

maximumIndicatorsCount?: string | number

Controls the maximum indicator controls (dots) that can be shown. Default value is 10.

Optional paused

paused?: ((s, e) => void)

Type declaration

Optional playing

playing?: ((s, e) => void)

Type declaration

Optional slideChanged

slideChanged?: ((s, e) => void)

Type declaration

Optional slidesLabelFormat

slidesLabelFormat?: string

The format used to set the aria-label on the carousel slides and the text displayed when the number of indicators is greater than tha maximum indicator count. Instances of '{0}' will be replaced with the index of the corresponding slide. Instances of '{1}' will be replaced with the total amount of slides.

Optional style

style?: CSSProperties

Optional vertical

vertical?: string | boolean

Whether the carousel has vertical alignment.