Search documentation

Search by topic, API name, or import path.

GitHub ↗

namespace / @typed/ui/index

Carousel

Public namespace exposed as Carousel from @typed/ui/index.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
namespace

Import

import { Carousel } from "@typed/ui/index";

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export * as Carousel from "./Carousel.js";

Members

  • Carousel.ControlOptions

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

  • Carousel.InitialState

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

  • Carousel.Next

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

  • Carousel.Previous

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

  • Carousel.Root

    Renders the carousel region and pauses automatic rotation on focus or pointer entry without replacing its child nodes.

  • Carousel.RootOptions

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

  • Carousel.RotationControl

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

  • Carousel.Slide

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

  • Carousel.SlideOptions

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

  • Carousel.State

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

  • Carousel.StateSchema

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

  • Carousel.makeCollection

    Creates a scoped Collection for Carousel items.

  • Carousel.makeState

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

  • Carousel.move

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

  • Carousel.select

    Sets activeId without changing paused state.

  • Carousel.toggleRotation

    Flips paused and preserves activeId.

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source