Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/ui

Carousel.StateSchema

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

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Slide and rotation state
Since
1.0.0
Member of
Carousel

Import

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

Access Carousel.StateSchema 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 declare const StateSchema: Schema.Struct<{
    readonly activeId: Schema.String;
    readonly paused: Schema.Boolean;
}>;

Examples

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

const decodeState = Schema.decodeUnknownEffect(Carousel.StateSchema);

Other public imports

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

Source