BetaBeta pública — Consulta las notas de lanzamiento
Solidiom
Comenzar
Documentación

Carousel

Horizontal slide-based content viewer.

Paquete
@solidiom/carousel
Versión
0.0.1-next.0
Estado
stable

Generado a partir del código fuente público del paquete.

API

CarouselContextValueinterfaz

Context shape shared among all carousel parts.

Propiedades

canScrollNext
Accessor<boolean> — Whether scrolling to next is possible.
canScrollPrev
Accessor<boolean> — Whether scrolling to previous is possible.
geometry
CarouselGeometry — The geometry configuration.
goTo
(index: number) => void — Navigate to a specific slide index.
loop
boolean — Whether loop mode is enabled.
next
() => void — Navigate to next slide.
paused
Accessor<boolean> — Whether the carousel is paused (autoplay).
physics
CarouselPhysicsPort — The physics port.
prev
() => void — Navigate to previous slide.
selectedIndex
Accessor<number> — Currently selected slide index.
setPaused
(paused: boolean) => void — Set paused state.

Ver código fuente

CarouselGeometryinterfaz

Geometry descriptor for the carousel layout.

Propiedades

containerWidth
number
gap
number
slideCount
number
slideWidth
number

Ver código fuente

CarouselNextButtonPropsinterfaz

Props for the Carousel NextButton.

hijos: Element

Ver código fuente

CarouselPhysicsPortinterfaz

Port interface for carousel physics/snap computation.

Ver código fuente

CarouselPhysicsResultinterfaz

Result from physics computation.

Propiedades

canScrollNext
boolean
canScrollPrev
boolean
scrollPosition
number
selectedIndex
number
snapPoints
number[]

Ver código fuente

CarouselPrevButtonPropsinterfaz

Props for the Carousel PrevButton.

hijos: Element

Ver código fuente

CarouselRootPropsinterfaz

Props for the Carousel Root component.

Propiedades

autoPlay?
number — Auto-play interval in ms. 0 or undefined disables.
class?
string — CSS class.
defaultIndex?
number — Default index for uncontrolled mode.
geometry
CarouselGeometry — Geometry of the carousel layout.
loop?
boolean — Enable looping. Defaults to false.
onIndexChange?
(index: number) => void — Callback when selected index changes.
physics?
CarouselPhysicsPort — Physics port. Defaults to simpleSnapPhysics.
selectedIndex?
Accessor<number | undefined> — Controlled selected index.

hijos: Element

Ver código fuente

CarouselSlidePropsinterfaz

Props for the Carousel Slide component.

Propiedades

index
number — Index of this slide.

hijos: Element

Ver código fuente

CarouselViewportPropsinterfaz

Props for the Carousel Viewport (scroll container).

hijos: Element

Ver código fuente

NextButtoncomponente

@solidiom/carousel — Headless carousel primitive. Parts: Root, Viewport, Slide, PrevButton, NextButton. Supports scroll-snap, pointer drag-to-swipe, keyboard nav, loop mode, auto-play.

                        NextButton(props: CarouselNextButtonProps): Element

hijos: Element

Ver código fuente

PrevButtoncomponente

@solidiom/carousel — Headless carousel primitive. Parts: Root, Viewport, Slide, PrevButton, NextButton. Supports scroll-snap, pointer drag-to-swipe, keyboard nav, loop mode, auto-play.

                        PrevButton(props: CarouselPrevButtonProps): Element

hijos: Element

Ver código fuente

Rootcomponente

@solidiom/carousel — Headless carousel primitive. Parts: Root, Viewport, Slide, PrevButton, NextButton. Supports scroll-snap, pointer drag-to-swipe, keyboard nav, loop mode, auto-play.

                        Root(props: CarouselRootProps): Element

Propiedades

autoPlay?
number — Auto-play interval in ms. 0 or undefined disables.
class?
string — CSS class.
defaultIndex?
number — Default index for uncontrolled mode.
geometry
CarouselGeometry — Geometry of the carousel layout.
loop?
boolean — Enable looping. Defaults to false.
onIndexChange?
(index: number) => void — Callback when selected index changes.
physics?
CarouselPhysicsPort — Physics port. Defaults to simpleSnapPhysics.
selectedIndex?
Accessor<number | undefined> — Controlled selected index.

hijos: Element

Ver código fuente

simpleSnapPhysicsvariable

Default snap physics — no spring/momentum, just index * (slideWidth + gap).

Ver código fuente

Slidecomponente

@solidiom/carousel — Headless carousel primitive. Parts: Root, Viewport, Slide, PrevButton, NextButton. Supports scroll-snap, pointer drag-to-swipe, keyboard nav, loop mode, auto-play.

                        Slide(props: CarouselSlideProps): Element

Propiedades

index
number — Index of this slide.

hijos: Element

Ver código fuente

useCarouselContextcontexto

                        useCarouselContext(): CarouselContextValue

Ver código fuente

Viewportcomponente

@solidiom/carousel — Headless carousel primitive. Parts: Root, Viewport, Slide, PrevButton, NextButton. Supports scroll-snap, pointer drag-to-swipe, keyboard nav, loop mode, auto-play.

                        Viewport(props: CarouselViewportProps): Element

hijos: Element

Ver código fuente