function / @typed/ui/index

WindowSplitter.adjust

Adds a delta and clamps the resulting splitter value.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Bounded resizing
Since
1.0.0
Member of
WindowSplitter

Import

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

Access WindowSplitter.adjust 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 adjust<E, R>(state: RefSubject.RefSubject<State, E, R>, delta: number): Effect.Effect<State, E, R>;

Examples

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

const program = Effect.gen(function* () {
  const state = yield* WindowSplitter.makeState({ value: 320, step: 24 })
  yield* WindowSplitter.adjust(state, 24)
})

Other public imports

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

Source