Interface: GridOptions ​

features/grids/grid.GridOptions

An object that configures a Grid.

Properties ​

cols ​

• cols: Computable<number>

The number of columns in the grid.

Defined in ​

profectus/src/features/grids/grid.ts:230

getCanClick ​

• Optional getCanClick: CellComputable<boolean>

A computable to determine if a cell can be clicked.

Defined in ​

profectus/src/features/grids/grid.ts:234

getClasses ​

• Optional getClasses: CellComputable<Record<string, boolean>>

A computable to get the CSS classes for a cell.

Defined in ​

profectus/src/features/grids/grid.ts:240

getDisplay ​

• getDisplay: CellComputable<CoercableComponent>

A computable to get the display component for a cell.

Defined in ​

profectus/src/features/grids/grid.ts:244

getStartState ​

• getStartState: Computable<State> | (id: string | number) => State

A computable to get the initial persistent state of a cell.

Defined in ​

profectus/src/features/grids/grid.ts:236

getStyle ​

• Optional getStyle: CellComputable<StyleValue>

A computable to get the CSS styles for a cell.

Defined in ​

profectus/src/features/grids/grid.ts:238

getTitle ​

• Optional getTitle: CellComputable<CoercableComponent>

A computable to get the title component for a cell.

Defined in ​

profectus/src/features/grids/grid.ts:242

getVisibility ​

• Optional getVisibility: CellComputable<boolean | Visibility>

A computable to determine the visibility of a cell.

Defined in ​

profectus/src/features/grids/grid.ts:232

onClick ​

• Optional onClick: (id: string | number, state: State, e?: MouseEvent | TouchEvent) => void

Type declaration ​

▸ (id, state, e?): void

A function that is called when a cell is clicked.

Parameters ​

Returns ​

void

Defined in ​

profectus/src/features/grids/grid.ts:246

onHold ​

• Optional onHold: (id: string | number, state: State) => void

Type declaration ​

▸ (id, state): void

A function that is called when a cell is held down.

Parameters ​

Returns ​

void

Defined in ​

profectus/src/features/grids/grid.ts:248

rows ​

• rows: Computable<number>

The number of rows in the grid.

Defined in ​

profectus/src/features/grids/grid.ts:228

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this grid should be visible.

Defined in ​

profectus/src/features/grids/grid.ts:226