UdashCarousel

Type Members

case class AnimationOptions(interval: Duration = 5 seconds, pause: PauseOption = PauseOption.Hover, wrap: Boolean = true, keyboard: Boolean = true, active: Boolean = true) extends Product with Serializable

UdashCarousel animation options.
UdashCarousel animation options.
interval
The amount of time to delay between automatically cycling an item.
pause
Indicated whether the carousel should pass on some specific event. See UdashCarousel.AnimationOptions.PauseOption.
wrap
Should the carousel cycle continuously or have hard stops.
keyboard
Should the carousel react to keyboard events.
active
Should the animation be active.
final case class CarouselEvent[ItemType, ElemType <: udash.ReadableProperty[ItemType]](source: UdashCarousel[ItemType, ElemType], targetIndex: Int, direction: Direction, changed: Boolean) extends AbstractCase with component.ListenableEvent[UdashCarousel[ItemType, ElemType]] with Product with Serializable

Event emitted by UdashCarousel on slide change transition start
Event emitted by UdashCarousel on slide change transition start
source
The UdashCarousel emitting the event.
targetIndex
The index of the slide source transitioned to.
direction
The animation direction. Either CarouselEvent.Direction.Left or CarouselEvent.Direction.Right.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object AnimationOptions extends Serializable
object CarouselEvent extends Serializable
def apply[ItemType, ElemType <: udash.ReadableProperty[ItemType]](slides: properties.seq.ReadableSeqProperty[ItemType, ElemType], showIndicators: udash.ReadableProperty[Boolean] = UdashBootstrap.True, animationOptions: udash.ReadableProperty[AnimationOptions] = AnimationOptions().toProperty, srTexts: Option[(TranslationKey0, TranslationKey0, LangProperty, TranslationProvider)] = None, activeSlide: udash.Property[Int] = Property(0), componentId: component.ComponentId = ComponentId.newId())(slideContentFactory: (ElemType, NestedInterceptor) ⇒ scalatags.JsDom.all.Modifier): UdashCarousel[ItemType, ElemType]

Creates a carousel component.
Creates a carousel component. More: Bootstrap Docs.
ItemType
A single element's type in the items sequence.
ElemType
A type of a property containing an element in the items sequence.
slides
A SeqProperty of carousel slides.
showIndicators
If true, the component shows carousel slide indicators.
animationOptions
A carousel animation options.
srTexts
Translation keys for previous and next arrows aria.label texts.
activeSlide
An active carousel slide index.
componentId
The arousel DOM element id.
slideContentFactory
Creates content of a slide. Use the provided interceptor to properly clean up bindings inside the content.
returns
A UdashCarousel component, call render to create a DOM element representing this button.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def default(slides: udash.ReadableSeqProperty[UdashCarouselSlide], showIndicators: udash.ReadableProperty[Boolean] = UdashBootstrap.True, animationOptions: udash.ReadableProperty[AnimationOptions] = AnimationOptions().toProperty, srTexts: Option[(TranslationKey0, TranslationKey0, LangProperty, TranslationProvider)] = None, activeSlide: udash.Property[Int] = Property(0), componentId: component.ComponentId = ComponentId.newId())(slideContentFactory: (udash.ReadableProperty[UdashCarouselSlide], NestedInterceptor) ⇒ scalatags.JsDom.all.Modifier = ...): UdashCarousel[UdashCarouselSlide, udash.ReadableProperty[UdashCarouselSlide]]

Creates the UdashCarousel component consisting of UdashCarouselSlide.
Creates the UdashCarousel component consisting of UdashCarouselSlide. More: Bootstrap Docs.
slides
A SeqProperty of carousel slides.
showIndicators
If true, the component shows carousel slide indicators.
animationOptions
A carousel animation options.
srTexts
Translation keys for previous and next arrows aria.label texts.
activeSlide
An active carousel slide index.
componentId
The arousel DOM element id.
slideContentFactory
Creates content of a slide. Use the provided interceptor to properly clean up bindings inside the content.
returns
A UdashCarousel component, call render to create a DOM element representing this button.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: class UdashCarousel | package carousel

object UdashCarousel

Type Members

case class AnimationOptions(interval: Duration = 5 seconds, pause: PauseOption = PauseOption.Hover, wrap: Boolean = true, keyboard: Boolean = true, active: Boolean = true) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object AnimationOptions extends Serializable

object CarouselEvent extends Serializable

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped