interface / @typed/ui/index

Grid.RootOptions

Inputs accepted by Grid.Root in addition to the shared DOM host options.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Grid surface
Since
1.0.0
Member of
Grid

Import

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

Access Grid.RootOptions through the imported Grid 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 RootOptions extends Dom.HostOptions<HTMLDivElement> {
    readonly state: RefSubject.HydratedRefSubject<State, Schema.SchemaError>;
    readonly collection?: RefSubject.RefSubject<Collection.State<CellPosition>>;
    readonly label: Renderable.Any<string | null | undefined>;
    readonly content: Renderable.Any;
    readonly multiselectable?: Renderable.Any<boolean | null | undefined>;
}

Property: collection

Item registry used for collection-driven keyboard behavior and mounted ordering.

Property: content

Renderable child content for the component host.

Property: label

Accessible label rendered through aria-label.

Property: multiselectable

Whether aria-multiselectable is announced on the grid.

Property: state

Renderer-independent RefSubject state consumed by this component or operation.

Other public imports

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

Source