Type Alias: EntityTableController<M>

EntityTableController<M>: object

You can use this controller to control the table view of a collection.

Type Parameters

• M extends Record<string, any> = any

Type declaration

checkFilterCombination()?

optional checkFilterCombination: (filterValues, sortBy?) => boolean

Parameters

• filterValues: FilterValues<any>

• sortBy?: [string, "asc" | "desc"]

Returns

boolean

clearFilter()?

optional clearFilter: () => void

Returns

void

data

data: Entity<M>[]

dataLoading

dataLoading: boolean

dataLoadingError?

optional dataLoadingError: Error

filterValues?

optional filterValues: FilterValues<Extract<keyof M, string>>

itemCount?

optional itemCount: number

noMoreToLoad

noMoreToLoad: boolean

onAddColumn()?

optional onAddColumn: (column) => void

Parameters

• column: string

Returns

void

pageSize?

optional pageSize: number

paginationEnabled?

optional paginationEnabled: boolean

popupCell?

optional popupCell: SelectedCellProps<M>

searchString?

optional searchString: string

setFilterValues()?

optional setFilterValues: (filterValues) => void

Parameters

• filterValues: FilterValues<Extract<keyof M, string>>

Returns

void

setItemCount()?

optional setItemCount: (itemCount) => void

Parameters

• itemCount: number

Returns

void

setPopupCell()?

optional setPopupCell: (popupCell?) => void

Parameters

• popupCell?: SelectedCellProps<M>

Returns

void

setSearchString()?

optional setSearchString: (searchString?) => void

Parameters

• searchString?: string

Returns

void

setSortBy()?

optional setSortBy: (sortBy?) => void

Parameters

• sortBy?: [Extract<keyof M, string>, "asc" | "desc"]

Returns

void

sortBy?

optional sortBy: [Extract<keyof M, string>, "asc" | "desc"]

Defined in

packages/firecms_core/src/types/collections.ts:559