function / @typed/ui

Dialog.close

Marks dialog state closed without requesting native cancellation.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Direct dismissal
Since
1.0.0
Member of
Dialog

Import

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

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

Why

Programmatic close is distinct from requestClose, which runs the browser’s cancelable close-request lifecycle.

Ownership and lifetime

The Effect updates existing state and acquires no resource.

Examples

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

const program = Effect.gen(function* () {
  const state = yield* Dialog.makeState({ open: true })
  yield* Dialog.close(state)
})

Other public imports

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

Source