interface / @typed/ui/index

WindowSplitter.InitialState

Initial splitter range and keyboard configuration.

Learn this UI primitive →

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

Import

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

Access WindowSplitter.InitialState 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 interface InitialState {
    readonly value: number;
    readonly min?: number;
    readonly max?: number;
    readonly step?: number;
    readonly orientation?: Orientation;
}

Property: max

Maximum value, defaulting to one hundred.

Property: max: Property: max

It defines the upper keyboard and ARIA bound. Callers must ensure it is greater than or equal to min; neither the schema nor constructor compares them.

Property: min

Minimum value, defaulting to zero.

Property: min: Property: min

It defines the collapsed boundary and Home result. Callers must ensure it is less than or equal to max; neither the schema nor constructor compares them.

Property: orientation

Separator orientation, defaulting to vertical.

Property: orientation: Property: orientation

Orientation determines ARIA output and arrow-key mapping.

Property: step

Arrow-key increment, defaulting to ten.

Property: step: Property: step

The widget needs an explicit adjustment granularity. Callers must provide a positive value; Schema.Finite rejects infinities and NaN but accepts zero and negative numbers.

Property: value

Initial pane size, clamped to min/max.

Property: value: Property: value

Invalid out-of-range starts become a valid accessible value.

Other public imports

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

Source