interface / @typed/ui/index

Carousel.ControlOptions

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

Learn this UI primitive →

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

Import

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

Access Carousel.ControlOptions 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 ControlOptions extends Dom.HostOptions<HTMLButtonElement> {
    readonly state: RefSubject.HydratedRefSubject<State, Schema.SchemaError>;
    readonly collection?: RefSubject.RefSubject<Collection.State<string>>;
    readonly content: Renderable.Any;
}

Property: collection

Item registry used for collection-driven keyboard behavior and mounted ordering.

Property: content

Renderable child content for the component host.

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