Module / v1.0.0-beta.13

@typed/ui/Carousel

16 unique exports available through this public import path, including their members and aliases.

Learn this UI primitive →

import * as Carousel from "@typed/ui/Carousel";

Rotation policy

  • RotationControl

    function

    Renders a button whose native click toggles the explicit paused state.

  • toggleRotation

    function

    Flips paused and preserves activeId.

Slide and rotation state

  • InitialState

    interface

    Initial Carousel values. activeId is required and paused defaults to true.

  • State

    interface

    The visible slide identity and explicit paused flag. Changing paused does not start a timer; an application scheduler must honor the flag.

  • StateSchema

    variable

    Effect Schema used by makeState to encode, decode, and hydrate Carousel state.

  • makeState

    function

    Creates hydrated Carousel state. activeId is required and paused defaults to true.

Slide content

  • Slide

    function

    Renders one labelled slide, registers it when a collection is supplied, and toggles hidden from activeId.

  • SlideOptions

    interface

    Inputs accepted by Carousel.Slide in addition to the shared DOM host options.

Slide controls

  • ControlOptions

    interface

    Inputs accepted by Carousel.Control in addition to the shared DOM host options.

  • Next

    function

    Renders a button whose native click selects the next registered slide with wrapping enabled.

  • Previous

    function

    Renders a button whose native click selects the previous registered slide with wrapping enabled.

Slide navigation

  • move

    function

    Selects the previous or next enabled registered slide; movement wraps and leaves state unchanged for an empty collection.

  • select

    function

    Sets activeId without changing paused state.

Slide registration