kvision-onsenui/io.kvision.onsenui.carousel/Carousel

Carousel

open class Carousel(direction: CarouselDirection? = null, fullscreen: Boolean? = null, overscrollable: Boolean? = null, autoScroll: Boolean? = null, animation: Boolean? = null, swipeable: Boolean? = null, initialIndex: Int? = null, className: String? = null, init: Carousel.() -> Unit? = null)

A carousel component.

Parameters

direction

a carousel direction

fullscreen

whether the carousel should fill the whole screen

overscrollable

whether the carousel should scroll past first and last items

autoScroll

whether the carousel will be automatically scrolled to the closest item border

animation

determines if the transitions are animated

swipeable

determines if the carousel can be scrolled by drag or swipe

className

CSS class names

init

an initializer extension function

Constructors

Carousel

constructor(direction: CarouselDirection? = null, fullscreen: Boolean? = null, overscrollable: Boolean? = null, autoScroll: Boolean? = null, animation: Boolean? = null, swipeable: Boolean? = null, initialIndex: Int? = null, className: String? = null, init: Carousel.() -> Unit? = null)

Creates a carousel component.

Properties

animation

var animation: Boolean?

Determines if the transitions are animated.

autoRefresh

var autoRefresh: Boolean?

Whether the carousel will automatically refresh when the number of child nodes change.

autoScroll

var autoScroll: Boolean?

Whether the carousel will be automatically scrolled to the closest item border.

autoScrollRatio

var autoScrollRatio: Number?

Specifies how much the user must drag the carousel in order for it to auto scroll to the next item.

centered

var centered: Boolean?

Whether the selected item will be in the center of the carousel instead of the beginning.

direction

var direction: CarouselDirection?

A carousel direction.

disabled

var disabled: Boolean?

Whether the carousel is disabled.

fullscreen

var fullscreen: Boolean?

Whether the carousel should fill the whole screen.

initialIndex

var initialIndex: Int?

The index of the item to show on start.

itemCount

val itemCount: dynamic

A dynamic property returning the number of carousel items.

itemHeight

var itemHeight: <Error class: unknown class>?

The item height (only for vertical direction).

itemWidth

var itemWidth: <Error class: unknown class>?

The item width (only for horizontal direction).

overscrollable

var overscrollable: Boolean?

Whether the carousel should scroll past first and last items.

swipeable

var swipeable: Boolean?

Determines if the carousel can be scrolled by drag or swipe.

swiperPanel

val swiperPanel: <Error class: unknown class>

The swiper inner container.

Functions

add

open fun add(child: <Error class: unknown class>)

open fun add(position: Int, child: <Error class: unknown class>)

addAll

open fun addAll(children: List<<Error class: unknown class>>)

afterInsert

open fun afterInsert(node: <Error class: unknown class>)

buildAttributeSet

open fun buildAttributeSet(attributeSetBuilder: <Error class: unknown class>)

carouselItem

fun Carousel.carouselItem(content: String? = null, rich: Boolean = false, align: <Error class: unknown class>? = null, className: String? = null, init: CarouselItem.() -> Unit? = null): CarouselItem

DSL builder extension function.

dispose

open fun dispose()

disposeAll

open fun disposeAll()

first