function / @typed/ui

WindowSplitter.WindowSplitter

Renders a focusable ARIA separator for resizing a pane.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Resize separator
Since
1.0.0
Member of
WindowSplitter

Import

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

Access WindowSplitter.WindowSplitter 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 WindowSplitter<const Options extends WindowSplitterOptions, const Host extends HostResult = never>(options: Options, host?: Dom.HostOverride<Dom.RenderHostProps<Options, WindowSplitterInternalProps<Options>>, "", Host>): import("./Dom/Types.js").HostComponent<Options | Host>;

Examples

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

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

Other public imports

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

Source