InterfaceDataTableTableProps

Admin Docs

---

Interface: InterfaceDataTableTableProps<T>

Defined in: src/types/shared-components/DataTable/props.ts:198

Props for the DataTableTable component that renders table rows.

Provides data and configuration for rendering paginated table content, including row selection, actions, and custom empty states.

Type Parameters

T

T

The type of data for each row in the table

Properties

activeSortBy?

optional activeSortBy: string

Defined in: src/types/shared-components/DataTable/props.ts:226

ID of the currently sorted column

---

activeSortDir?

optional activeSortDir: SortDirection

Defined in: src/types/shared-components/DataTable/props.ts:228

Current sort direction

---

allSelectedOnPage?

optional allSelectedOnPage: boolean

Defined in: src/types/shared-components/DataTable/props.ts:222

Whether all rows on page are selected

---

ariaBusy?

optional ariaBusy: boolean

Defined in: src/types/shared-components/DataTable/props.ts:210

ARIA busy state for the table

---

ariaLabel?

optional ariaLabel: string

Defined in: src/types/shared-components/DataTable/props.ts:208

ARIA label for the table element

---

columns

columns: IColumnDef<T, unknown>[]

Defined in: src/types/shared-components/DataTable/props.ts:200

Array of column definitions specifying how to render each column

---

currentSelection

currentSelection: ReadonlySet<Key>

Defined in: src/types/shared-components/DataTable/props.ts:238

Current selection state

---

effectiveRowActions

effectiveRowActions: readonly IRowAction<T>[]

Defined in: src/types/shared-components/DataTable/props.ts:246

Array of effective row actions

---

effectiveSelectable?

optional effectiveSelectable: boolean

Defined in: src/types/shared-components/DataTable/props.ts:214

Whether selection is enabled

---

getKey()

getKey: (row, idx) => string | number

Defined in: src/types/shared-components/DataTable/props.ts:236

Function to get unique key for a row

Parameters

row

T

idx

number

Returns

string | number

---

handleHeaderClick()

handleHeaderClick: (col) => void

Defined in: src/types/shared-components/DataTable/props.ts:230

Callback when header is clicked for sorting

Parameters

col

IColumnDef<T, unknown>

Returns

void

---

hasRowActions?

optional hasRowActions: boolean

Defined in: src/types/shared-components/DataTable/props.ts:216

Whether row actions are present

---

headerCheckboxRef?

optional headerCheckboxRef: RefObject<HTMLInputElement>

Defined in: src/types/shared-components/DataTable/props.ts:218

Ref to the header checkbox for select all

---

keysToShowRows?

optional keysToShowRows: ReadonlySet<Key>

Defined in: src/types/shared-components/DataTable/props.ts:202

Set of row keys to display; if provided, only these rows are shown

---

loadingMore?

optional loadingMore: boolean

Defined in: src/types/shared-components/DataTable/props.ts:248

Whether more rows are loading

---

renderRow()?

optional renderRow: (row, index) => ReactNode

Defined in: src/types/shared-components/DataTable/props.ts:244

Custom function to render each row

Parameters

row

T

index

number

Returns

ReactNode

---

selectAllOnPage()

selectAllOnPage: (checked) => void

Defined in: src/types/shared-components/DataTable/props.ts:224

Callback to select/deselect all rows on page

Parameters

checked

boolean

Returns

void

---

skeletonRows?

optional skeletonRows: number

Defined in: src/types/shared-components/DataTable/props.ts:250

Number of skeleton rows to show

---

someSelectedOnPage?

optional someSelectedOnPage: boolean

Defined in: src/types/shared-components/DataTable/props.ts:220

Whether some rows on page are selected

---

sortable?

optional sortable: boolean

Defined in: src/types/shared-components/DataTable/props.ts:204

Whether columns are sortable (default: true)

---

sortedRows

sortedRows: readonly T[]

Defined in: src/types/shared-components/DataTable/props.ts:232

Array of sorted rows to display

---

sortState?

optional sortState: ISortState

Defined in: src/types/shared-components/DataTable/props.ts:206

Current sort state specifying column and direction

---

startIndex

startIndex: number

Defined in: src/types/shared-components/DataTable/props.ts:234

Starting index for row numbering

---

tableClassNames?

optional tableClassNames: string

Defined in: src/types/shared-components/DataTable/props.ts:212

CSS classes to apply to the table

---

tCommon()

tCommon: (key, options?) => string

Defined in: src/types/shared-components/DataTable/props.ts:242

Translation function for common strings

Parameters

key

string

options?

Record<string, unknown>

Returns

string

---

toggleRowSelection()

toggleRowSelection: (key) => void

Defined in: src/types/shared-components/DataTable/props.ts:240

Callback to toggle row selection

Parameters

key

Key

Returns

void