Logo FS-Skia-UI

DataGrid Module

Virtualized data-grid control: an MVU `init`/`update` core plus attribute builders for authoring a grid against the typed `Props` front door.

Functions and values

Function or value Description

columns columns

Full Usage: columns columns

Parameters:
Returns: Attr<'msg>
Type parameters: 'msg

Attribute setting the grid's `columns` definition on a data-grid control.

columns : DataGridColumn list
Returns: Attr<'msg>

create columns attrs

Full Usage: create columns attrs

Parameters:
Returns: Control<'msg>
Type parameters: 'msg

Authors a data-grid `Control` over the given `columns` and `attrs` — the legacy builder behind the typed `Props` front door.

columns : DataGridColumn list
attrs : Attr<'msg> list
Returns: Control<'msg>

focusedCell focusedCell

Full Usage: focusedCell focusedCell

Parameters:
Returns: Attr<'msg>
Type parameters: 'msg

Attribute setting the grid's `focusedCell` for keyboard navigation, or `None` to clear focus.

focusedCell : DataGridFocusedCell option
Returns: Attr<'msg>

init controlId columns rowCount rowHeight viewportHeight

Full Usage: init controlId columns rowCount rowHeight viewportHeight

Parameters:
Returns: DataGridModel * DataGridEffect list

Builds the initial `DataGridModel` for `controlId` from its columns and row/viewport metrics, with the first visible-range effects.

controlId : ControlId
columns : DataGridColumn list
rowCount : int
rowHeight : float
viewportHeight : float
Returns: DataGridModel * DataGridEffect list

rows rows

Full Usage: rows rows

Parameters:
Returns: Attr<'msg>
Type parameters: 'msg

Attribute supplying the grid's `rows` of cell data to a data-grid control.

rows : DataGridRow list
Returns: Attr<'msg>

selectedRows selectedRows

Full Usage: selectedRows selectedRows

Parameters:
    selectedRows : Set<string>

Returns: Attr<'msg>
Type parameters: 'msg

Attribute marking the set of `selectedRows` (by row key) on a data-grid control.

selectedRows : Set<string>
Returns: Attr<'msg>

update msg model

Full Usage: update msg model

Parameters:
Returns: DataGridModel * DataGridEffect list

Applies a `DataGridMsg` to `model`, returning the next state and any `DataGridEffect`s the change produces.

msg : DataGridMsg
model : DataGridModel
Returns: DataGridModel * DataGridEffect list

visibleRange visibleRange

Full Usage: visibleRange visibleRange

Parameters:
Returns: Attr<'msg>
Type parameters: 'msg

Attribute pinning the grid's `visibleRange` — the virtualized window of rows currently rendered.

visibleRange : VisibleRange
Returns: Attr<'msg>

Type something to start searching.