interface / @typed/ui/index

Grid.CellOptions

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

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Cells and headers
Since
1.0.0
Member of
Grid

Import

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

Access Grid.CellOptions 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 CellOptions extends Dom.HostOptions<HTMLDivElement> {
    readonly state: RefSubject.HydratedRefSubject<State, Schema.SchemaError>;
    readonly collection?: RefSubject.RefSubject<Collection.State<CellPosition>>;
    readonly id: string;
    readonly rowId: string;
    readonly columnIndex: number;
    readonly rowIndex?: number;
    readonly selected?: Renderable.Any<boolean | null | undefined>;
    readonly content: Renderable.Any;
}

Property: collection

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

Property: columnIndex

Caller-supplied column index used for movement and emitted unchanged as aria-colindex; ARIA indexes are one-based.

Property: content

Renderable child content for the component host.

Property: id

Stable id used for collection identity and ARIA relationships.

Property: rowId

Stable logical row identity used by vertical grid movement.

Property: rowIndex

Optional one-based aria-rowindex value supplied by the caller.

Property: selected

Optional selected state exposed through aria-selected.

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