Skip to content
On this page

Interface: BaseGrid

features/grids/grid.BaseGrid

Properties

[Component]

[Component]: DefineComponent<{ cells: { required: true = true; type: PropType<ProcessedComputable<Record<string, GridCell>>> } ; cols: { required: true = true; type: PropType<ProcessedComputable<number>> } ; rows: { required: true = true; type: PropType<ProcessedComputable<number>> } ; visibility: { required: true = true; type: PropType<ProcessedComputable<Visibility>> } }, { Visibility: typeof Visibility ; gatherCellProps: (cell: GridCell) => { canClick: boolean ; display: CoercableComponent ; id: string ; onClick: undefined | (e?: MouseEvent | TouchEvent) => void ; onHold: undefined | VoidFunction ; style: undefined | StyleValue ; title: undefined | CoercableComponent ; visibility: Visibility } ; mergeAdjacent: ComputedRef<boolean> ; unref: <T>(ref: T | Ref<T>) => T }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, Record<string, any>, string, PublicProps, Readonly<ExtractPropTypes<{ cells: { required: true = true; type: PropType<ProcessedComputable<Record<string, GridCell>>> } ; cols: { required: true = true; type: PropType<ProcessedComputable<number>> } ; rows: { required: true = true; type: PropType<ProcessedComputable<number>> } ; visibility: { required: true = true; type: PropType<ProcessedComputable<Visibility>> } }>>, {}>

Defined in

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


[GatherProps]

[GatherProps]: () => Record<string, unknown>

Type declaration

▸ (): Record<string, unknown>

Returns

Record<string, unknown>

Defined in

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


cellState

cellState: Persistent<Record<string | number, State>>

Defined in

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


cells

cells: Record<string | number, GridCell>

Defined in

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


getID

getID: (id: string | number, state: State) => string

Type declaration

▸ (id, state): string

Parameters
NameType
idstring | number
stateState
Returns

string

Defined in

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


getState

getState: (id: string | number) => State

Type declaration

▸ (id): State

Parameters
NameType
idstring | number
Returns

State

Defined in

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


id

id: string

Defined in

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


setState

setState: (id: string | number, state: State) => void

Type declaration

▸ (id, state): void

Parameters
NameType
idstring | number
stateState
Returns

void

Defined in

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


type

type: typeof GridType

Defined in

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