interface / @typed/ui/index

Carousel.RootOptions

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

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Carousel region
Since
1.0.0
Member of
Carousel

Import

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

Access Carousel.RootOptions through the imported Carousel export. Its declaration below describes the member.

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

Signatures

export interface RootOptions extends Dom.HostOptions<HTMLDivElement> {
    readonly state: RefSubject.HydratedRefSubject<State, Schema.SchemaError>;
    readonly content: Renderable.Any;
    readonly label: Renderable.Any<string | null | undefined>;
}

Property: content

Renderable child content for the component host.

Property: label

Accessible label rendered through aria-label.

Property: state

Renderer-independent RefSubject state consumed by this component or operation.

Other public imports

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

Source