Search documentation

Search by topic, API name, or import path.

GitHub ↗

function / @typed/ui/index

Hovercard.makeState

Creates hydrated hovercard state.

Learn this UI primitive →

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

Import

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

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

Why

Visibility and identity can be tested without mounting UI.

Ownership and lifetime

The calling Effect Scope owns the returned RefSubject.

Examples

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

const program = Effect.gen(function* () {
  return yield* Hovercard.makeState({ id: "author-card" })
})

Other public imports

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

Source