Search documentation

Search by topic, API name, or import path.

GitHub ↗

function / @typed/ui

WindowSplitter.makeState

Creates hydrated splitter state and clamps the initial value.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Pane sizing state
Since
1.0.0
Member of
WindowSplitter

Import

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

Access WindowSplitter.makeState through the imported WindowSplitter 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 value: number;
    readonly previousValue: number;
    readonly min: number;
    readonly max: number;
    readonly step: number;
    readonly orientation: "horizontal" | "vertical";
}, Schema.SchemaError, never, never>, never, Scope.Scope>;

Examples

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

const program = Effect.gen(function* () {
  return yield* WindowSplitter.makeState({ value: 320, min: 180, max: 640 })
})

Other public imports

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

Source