Search documentation

Search by topic, API name, or import path.

GitHub ↗

function / @typed/ui/index

Checkbox.toggle

Toggles checked state, treating the mixed state as unchecked.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
State transitions
Since
1.0.0
Member of
Checkbox

Import

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

Access Checkbox.toggle 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 toggle<E, R>(state: RefSubject.RefSubject<State, E, R>): Effect.Effect<State, E, R>;

Examples

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

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

Other public imports

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

Source