Skip to main content

DataRecordListProps

@gravity-rail/react


@gravity-rail/react / DataRecordListProps

Interface: DataRecordListProps

Properties​

className?​

optional className: string


columns?​

optional columns: string[]

Field slugs to show as columns. Defaults to the first 4 schema fields.


dataType​

dataType: DataType


emptyState?​

optional emptyState: ReactNode

Rendered when there are no records yet.


onDelete()?​

optional onDelete: (record) => void

When provided, a "Delete" action is shown per row (table variant only).

Parameters​

record​

DataRecord

Returns​

void


onEdit()?​

optional onEdit: (record) => void

When provided, an "Edit" action is shown per row (table variant only).

Parameters​

record​

DataRecord

Returns​

void


params?​

optional params: ListRecordsParams

List query params (paging, member filter, search).


refreshKey?​

optional refreshKey: unknown

Refresh trigger: change this value (e.g. after a create) to reload.


variant?​

optional variant: "table" | "cards"

Presentational layout. Defaults to "table".