function / @typed/ui

Checkbox.makeState

Creates hydrated, renderer-independent checkbox state.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
State construction
Since
1.0.0
Member of
Checkbox

Import

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

Access Checkbox.makeState through the imported Checkbox 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 function makeState(initial?: InitialState): Effect.Effect<RefSubject.HydratedRefSubject<{
    readonly checked: boolean | "mixed";
}, Schema.SchemaError, never, never>, never, import("effect/Scope").Scope>;

Examples

import { Effect } from "effect"
import * as Checkbox from "@typed/ui/Checkbox"

const program = Effect.gen(function* () {
  return yield* Checkbox.makeState({ checked: "mixed" })
})

Other public imports

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

Source