Mixins / foldkit-mixins-ui

CarouselView

interface · packages/mixins-ui/src/carousel.ts:73

interface CarouselView<Message> {
  readonly id: string
  readonly label: string
  readonly slides: ReadonlyArray<Html>
  readonly index: number
  readonly onIndex: (index: number) => NoInfer<Message>
  readonly loop?: boolean | undefined
  readonly picker?: boolean | undefined
  readonly slideLabel?: ((index: number, count: number) => string) | undefined
  readonly previousLabel?: string | undefined
  readonly nextLabel?: string | undefined
  readonly pickerLabel?: string | undefined
  readonly style?: NamedStyle<typeof CarouselSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

CarouselView.id

property · packages/mixins-ui/src/carousel.ts:75

readonly id: string

Prefixes every id the carousel draws, unique on the page.

CarouselView.label

property · packages/mixins-ui/src/carousel.ts:77

readonly label: string

What the slides are, naming the carousel.

CarouselView.slides

property · packages/mixins-ui/src/carousel.ts:78

readonly slides: ReadonlyArray<Html>

CarouselView.index

property · packages/mixins-ui/src/carousel.ts:80

readonly index: number

The slide shown, from 0; one out of range is read as the nearest end.

CarouselView.onIndex

property · packages/mixins-ui/src/carousel.ts:82

readonly onIndex: (index: number) => NoInfer<Message>

Sent by the buttons and dots with the slide they go to; answer it with ShowSlide.

CarouselView.loop

property · packages/mixins-ui/src/carousel.ts:84

readonly loop?: boolean | undefined

Whether next on the last slide goes to the first, and previous on the first to the last.

CarouselView.picker

property · packages/mixins-ui/src/carousel.ts:86

readonly picker?: boolean | undefined

Draws a dot per slide that goes to it; default true.

CarouselView.slideLabel

property · packages/mixins-ui/src/carousel.ts:88

readonly slideLabel?: ((index: number, count: number) => string) | undefined

How a slide is named, and the status and its dot say it; default "2 of 5".

CarouselView.previousLabel

property · packages/mixins-ui/src/carousel.ts:90

readonly previousLabel?: string | undefined

Default Previous slide.

CarouselView.nextLabel

property · packages/mixins-ui/src/carousel.ts:92

readonly nextLabel?: string | undefined

Default Next slide.

CarouselView.pickerLabel

property · packages/mixins-ui/src/carousel.ts:94

readonly pickerLabel?: string | undefined

Names the dots as a group; default Choose a slide.

CarouselView.style

property · packages/mixins-ui/src/carousel.ts:96

readonly style?: NamedStyle<typeof CarouselSlots> | undefined

A style of CarouselSlots, for the look.

CarouselView.mixins

property · packages/mixins-ui/src/carousel.ts:98

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.