@manta-eu/react/table

Enumerations

SortingHandlerPlacement

Enumeration Members

LEFT

LEFT: "left"

RIGHT

RIGHT: "right"

Interfaces

TableConfigProps

Type Parameters

T

T

Properties

columnFilters?

optional columnFilters?: ColumnFiltersState

columnOrder?

optional columnOrder?: ColumnOrderState

columnPinning?

optional columnPinning?: ColumnPinningState

columns

columns: ColumnDef<T>[]

columnVisibility?

optional columnVisibility?: VisibilityState

data

data: T[]

enableRowSelection?

optional enableRowSelection?: boolean | ((row) => boolean)

getRowId?

optional getRowId?: (row, index, parent?) => string

Parameters

row

T

index

number

parent?

Row<T>

Returns

string

manualPagination?

optional manualPagination?: boolean

manualSorting?

optional manualSorting?: boolean

pagination?

optional pagination?: PaginationState

rowSelection?

optional rowSelection?: RowSelectionState

setColumnFilters?

optional setColumnFilters?: OnChangeFn<ColumnFiltersState>

setColumnOrder?

optional setColumnOrder?: OnChangeFn<ColumnOrderState>

setColumnVisibility?

optional setColumnVisibility?: OnChangeFn<VisibilityState>

setPagination?

optional setPagination?: OnChangeFn<PaginationState>

setRowSelection?

optional setRowSelection?: OnChangeFn<RowSelectionState>

setSorting?

optional setSorting?: OnChangeFn<SortingState>

sorting?

optional sorting?: SortingState

Type Aliases

ColumnRearrangeDefaultState

ColumnRearrangeDefaultState = object

Properties

order

order: string[]

visibility

visibility: Record<string, boolean>

---

CombinedSortOption

CombinedSortOption<T> = `${T}-${“asc” | “desc”}`

Type Parameters

T

T extends string

---

DataTableBaseProps

DataTableBaseProps<TData> = HTMLAttributes<HTMLDivElement> & object

Type Parameters

TData

TData

Type Declaration

bodyClassName?

optional bodyClassName?: string

headerClassName?

optional headerClassName?: string

isLoading?

optional isLoading?: boolean

isRefetching?

optional isRefetching?: boolean

isRowClickable?

optional isRowClickable?: (row) => boolean

Parameters

row

Row<TData>

Returns

boolean

noResultsMessage?

optional noResultsMessage?: string

ref?

optional ref?: RefObject<HTMLDivElement>

renderRow?

optional renderRow?: (row) => ReactNode

Parameters

row

Row<TData>

Returns

ReactNode

rowClassName?

optional rowClassName?: (row) => string | undefined

Parameters

row

Row<TData>

Returns

string | undefined

size?

optional size?: TableSize

table

table: TableInstance<TData>

---

DataTableProps

DataTableProps<TData> = DataTableWithRowClick<TData> | DataTableWithRowHref<TData> | DataTableWithoutRowInteraction<TData>

Type Parameters

TData

TData

---

DataTableWithoutRowInteraction

DataTableWithoutRowInteraction<TData> = DataTableBaseProps<TData> & object

Type Parameters

TData

TData

Type Declaration

onRowClick?

optional onRowClick?: never

rowHref?

optional rowHref?: never

---

DataTableWithRowClick

DataTableWithRowClick<TData> = DataTableBaseProps<TData> & object

Type Parameters

TData

TData

Type Declaration

onRowClick

onRowClick: (row) => void

Parameters

row

Row<TData>

Returns

void

rowHref?

optional rowHref?: never

---

DataTableWithRowHref

DataTableWithRowHref<TData> = DataTableBaseProps<TData> & object

Type Parameters

TData

TData

Type Declaration

onRowClick?

optional onRowClick?: never

rowHref

rowHref: (row) => string

Parameters

row

Row<TData>

Returns

string

---

NumberCellProps

NumberCellProps<TData, TValue> = HTMLAttributes<HTMLDivElement> & object

Type Parameters

TData

TData

TValue

TValue

Type Declaration

cell

cell: Cell<TData, TValue>

---

PinnedColumnInfo

PinnedColumnInfo = object

Properties

isFirstRightPinnedColumn

isFirstRightPinnedColumn: boolean

isLastLeftPinnedColumn

isLastLeftPinnedColumn: boolean

isLeftPinned

isLeftPinned: boolean

isPinned

isPinned: boolean

isRightPinned

isRightPinned: boolean

---

SelectionColumnOptions

SelectionColumnOptions<TData> = object

Type Parameters

TData

TData

Properties

getRowAriaLabel?

optional getRowAriaLabel?: (row) => string

Parameters

row

Row<TData>

Returns

string

id?

optional id?: string

scope?

optional scope?: "all" | "page"

size?

optional size?: number

---

SortableColumn

SortableColumn<TRow> = object

Type Parameters

TRow

TRow

Properties

cell?

optional cell?: (row) => ReactNode

Parameters

row

TRow

Returns

ReactNode

header

header: string

key

key: keyof TRow & string

numeric?

optional numeric?: boolean

sortable?

optional sortable?: boolean

---

SortableTableBaseProps

SortableTableBaseProps<TRow> = object

Type Parameters

TRow

TRow

Properties

className?

optional className?: string

columns

columns: SortableColumn<TRow>[]

isLoading?

optional isLoading?: boolean

noResultsMessage?

optional noResultsMessage?: string

rows

rows: TRow[]

size?

optional size?: TableSize

---

SortableTableProps

SortableTableProps<TRow> = SortableTableBaseProps<TRow> & object | SortableTableBaseProps<TRow> & object | SortableTableBaseProps<TRow> & object

Type Parameters

TRow

TRow

---

TableColumnRearrangePopoverProps

TableColumnRearrangePopoverProps<TData> = WithClassName & object & ({ enableReset: true; resetLabel?: string; } | { enableReset?: false; resetLabel?: string; })

Type Parameters

TData

TData

Type Declaration

columnLabels?

optional columnLabels?: Record<string, string>

defaultOrder?

optional defaultOrder?: string[]

defaultState?

optional defaultState?: ColumnRearrangeDefaultState

defaultVisibility?

optional defaultVisibility?: Record<string, boolean>

formatLabel?

optional formatLabel?: (columnId) => string

Parameters

columnId

string

Returns

string

table

table: Table<TData>

title?

optional title?: string

---

TableProps

TableProps = ComponentProps<"table"> & object

Type Declaration

size?

optional size?: TableSize

---

TableSize

TableSize = "base" | "sm"

---

TColumnHeaderProps

TColumnHeaderProps<TData, TValue> = object

Type Parameters

TData

TData

TValue

TValue

Properties

children

children: ReactNode

column

column: Column<TData, TValue>

---

UseTableStateOptions

UseTableStateOptions = object

Properties

defaultPageSize?

optional defaultPageSize?: number

enableRowSelection?

optional enableRowSelection?: boolean

useLocalState?

optional useLocalState?: boolean

---

WithClassName

WithClassName = object

Properties

className?

optional className?: string

Functions

ColumnHeader()

ColumnHeader<TData, TValue>(__namedParameters): Element

Type Parameters

TData

TData

TValue

TValue

Parameters

__namedParameters

TColumnHeaderProps<TData, TValue>

Returns

Element

---

createTableConfig()

createTableConfig<T>(tableConfig): TableOptions<T>

Type Parameters

T

T

Parameters

tableConfig

TableConfigProps<T>

Returns

TableOptions<T>

---

CustomTableCell()

CustomTableCell<TData, TValue>(__namedParameters): Element

Type Parameters

TData

TData

TValue

TValue

Parameters

__namedParameters

cell

Cell<TData, TValue>

Returns

Element

---

DataTable()

DataTable<TData>(props): Element

Type Parameters

TData

TData

Parameters

props

DataTableProps<TData>

Returns

Element

---

getCommonPinnedColumnStyles()

getCommonPinnedColumnStyles<TData, TValue>(column): CSSProperties

Type Parameters

TData

TData

TValue

TValue

Parameters

column

Column<TData, TValue>

Returns

CSSProperties

---

getPinnedColumnInfo()

getPinnedColumnInfo<TData, TValue>(column): PinnedColumnInfo

Type Parameters

TData

TData

TValue

TValue

Parameters

column

Column<TData, TValue>

Returns

PinnedColumnInfo

---

NumberCell()

NumberCell<TData, TValue>(__namedParameters): Element

Type Parameters

TData

TData

TValue

TValue

Parameters

__namedParameters

NumberCellProps<TData, TValue>

Returns

Element

---

renderCellValue()

renderCellValue(value): ReactNode

Parameters

value

unknown

Returns

ReactNode

---

SortableTable()

SortableTable<TRow>(props): Element

Type Parameters

TRow

TRow extends object

Parameters

props

SortableTableProps<TRow>

Returns

Element

---

Table()

Table(__namedParameters): Element

Parameters

__namedParameters

TableProps

Returns

Element

---

TableBody()

TableBody(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLTableSectionElement>>

Returns

Element

---

TableCaption()

TableCaption(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLElement>>

Returns

Element

---

TableCell()

TableCell(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<TdHTMLAttributes<HTMLTableDataCellElement>>

Returns

Element

---

TableColumnRearrangePopover()

TableColumnRearrangePopover<TData>(props): Element | null

Type Parameters

TData

TData

Parameters

props

TableColumnRearrangePopoverProps<TData>

Returns

Element | null

---

TableFooter()

TableFooter(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLTableSectionElement>>

Returns

Element

---

TableHead()

TableHead(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<ThHTMLAttributes<HTMLTableHeaderCellElement>>

Returns

Element

---

TableHeader()

TableHeader(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLTableSectionElement>>

Returns

Element

---

TableRow()

TableRow(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLTableRowElement>>

Returns

Element

---

useMaxTableRows()

useMaxTableRows(): number | undefined

Returns

number | undefined

---

useSelectionColumn()

useSelectionColumn<TData>(options?): ColumnDef<TData>

Type Parameters

TData

TData

Parameters

options?

SelectionColumnOptions<TData>

Returns

ColumnDef<TData>

---

useTableState()

useTableState(tableKey, initialSorting?, options?): object

Parameters

tableKey

string

initialSorting?

SortingState = []

options?

UseTableStateOptions

Returns

object

columnFilters

columnFilters: ColumnFiltersState

columnOrder

columnOrder: ColumnOrderState

columnVisibility

columnVisibility: VisibilityState

debouncedSearchQuery

debouncedSearchQuery: string

enableRowSelection

enableRowSelection: boolean | undefined

pageIndex

pageIndex: number = pagination.pageIndex

pagination

pagination: PaginationState

rowSelection

rowSelection: object

searchQuery

searchQuery: string

setColumnFilters

setColumnFilters: Dispatch<SetStateAction<ColumnFiltersState>>

setColumnOrder

setColumnOrder: Dispatch<SetStateAction<ColumnOrderState>>

setColumnVisibility

setColumnVisibility: Dispatch<SetStateAction<VisibilityState>>

setPageIndex

setPageIndex: (pageIndex) => void

Parameters

pageIndex

number

Returns

void

setPagination

setPagination: Dispatch<SetStateAction<PaginationState>>

setRowSelection

setRowSelection: Dispatch<SetStateAction<{ }>>

setSearchQuery

setSearchQuery: (value, options?) => Promise<URLSearchParams>

Parameters

value

string | ((old) => string | null) | null

options?

Options

Returns

Promise<URLSearchParams>

setSorting

setSorting: Dispatch<SetStateAction<SortingState>>

sorting

sorting: SortingState