function / @typed/ui/index

Dialog.makeState

Creates hydrated dialog state independent of rendering.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Open state
Since
1.0.0
Member of
Dialog

Import

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

Access Dialog.makeState through the imported Dialog 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 open: boolean;
}, Schema.SchemaError, never, never>, never, Scope.Scope>;

Why

Application transitions can be composed and tested before a native dialog element exists.

Ownership and lifetime

The calling Effect Scope owns the returned RefSubject.

Examples

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

const program = Effect.gen(function* () {
  return yield* Dialog.makeState()
})

Other public imports

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

Source