DataTableV2
The DataTableV2
is a component for building tables which organize information
into rows and columns.
DataTableV2Props
Signature:
export declare type DataTableV2Props< = > = <> & & & & & & & & & <> & <> & <> & & & <> & & & & ;
DataTableV2BaseProps
Name | Type | Default | Description |
---|---|---|---|
data | [] | - | Data given to the DataTableV2. Needs to be memoized in order to ensure performant update cycles. |
columns | <>[] | - | Column definition given to the DataTableV2. Needs to be memoized in order to ensure performant update cycles. |
height? | - | Height can be defined to enable virtualization | |
fullWidth? | false | Enables DataTable to use the full width of its container. | |
fullHeight? | false | Enables DataTable to use the full height of its container. |
DataTableV2LineWrapBaseProps
Name | Type | Default | Description |
---|---|---|---|
onLineWrapChange? | (lineWrap: ) => | - | Callback that is called when the lineWrap state of the table or any column is changed. |
DataTableV2LineWrapUncontrolledProps
Name | Type | Default | Description |
---|---|---|---|
defaultLineWrap? | - | Lets you set lineWrap state initially of the entire table or individual columns.
|
DataTableV2LineWrapControlledProps
Name | Type | Default | Description |
---|---|---|---|
lineWrap? | - | Lets you control the lineWrap state of the entire table or individual columns.
|
DataTableV2ColumnFontStyleProps
Signature:
export declare type DataTableV2ColumnFontStyleProps = | ;
DataTableV2VisualVariantProps
Name | Type | Default | Description |
---|---|---|---|
variant? | {
/**
* rowSeparation can be set to which will provide lines between rows or
* can be set to which will provide alternate row coloring.
* @defaultValue
*/
rowSeparation?: | | ;
/**
* If true provides vertical lines between the columns.
* @defaultValue false
*/
verticalDividers?: ;
/**
* If true provides a border for the table.
* @defaultValue true
*/
contained?: ;
/**
* rowDensity adds spacing around the content inside the row
* with minimal space for , maximum spacing for and
* being medium spacing.
* @defaultValue
*/
rowDensity?: | | ;
/**
* fontStyle, sets the font style for the entire data table.
* This does not overwrite fontStyle set at the lower level, like columns etc.
* @defaultValue
*/
fontStyle?: | ;
/**
* headers defines if the header rows of the table should be rendered or not.
* @defaultValue
*/
headers?: | ;
} | - |
DataTableV2LoadingStateProps
Name | Type | Default | Description |
---|---|---|---|
loading? | false | Displays a loading indicator while the table's columns and/or data are being loaded. |
DataTableV2ColumnSizingBaseProps
Name | Type | Default | Description |
---|---|---|---|
resizable? | false | Enables resizable columns for the table. | |
onColumnSizingChange? | (newSizes: ) => | - | Callback that triggers when a user finishes resizing a column. |
DataTableV2ColumnSizingControlledProps
Name | Type | Default | Description |
---|---|---|---|
columnSizing? | - | ColumnSizing state that lets you set the individual column sizes in a controlled scenario. |
DataTableV2ColumnSizingUncontrolledProps
Name | Type | Default | Description |
---|---|---|---|
defaultColumnSizing? | - | ColumnSizing state that lets you set the individual column sizes in a uncontrolled scenario. |
DataTableV2SortingBaseProps
Name | Type | Default | Description |
---|---|---|---|
sortable? | | {
/**
* When set to true, the table will assume that the data provided by the consumer is already sorted,
* and will not apply sorting to it.
*/
manualSort?: ;
} | false | Enables sorting for all columns which do not have it explicitly
disabled with the |
onSortByChange? | (columnSorting: []) => | - | Callback triggered when sorting of the column is changed. |
DataTableV2SortingControlledProps
Name | Type | Default | Description |
---|---|---|---|
sortBy? | [] | - | Controlled property to define the columns the DataTableV2 is sorted by. |
DataTableV2SortingUncontrolledProps
Name | Type | Default | Description |
---|---|---|---|
defaultSortBy? | [] | - | Uncontrolled property to define the columns the DataTableV2 is sorted by. |
DataTableV2ColumnVisibilityBaseProps
Name | Type | Default | Description |
---|---|---|---|
onColumnVisibilityChange? | (columnVisibility: ) => | - | Callback that is called when the ColumnVisibility state of any column is changed. |
DataTableV2ColumnVisibilityControlledProps
Name | Type | Default | Description |
---|---|---|---|
columnVisibility? | - | Lets you control the ColumnVisibility state of the individual columns. |
DataTableV2ColumnVisibilityUncontrolledProps
Name | Type | Default | Description |
---|---|---|---|
defaultColumnVisibility? | - | Lets you set the initial ColumnVisibility state of the individual columns. |
DataTableV2ColumnOrderBaseProps
Name | Type | Default | Description |
---|---|---|---|
columnOrdering? | | {
/**
* When enabled, columns can be ordered via drag and drop by grabbing the header cell.
*/
enableDragAndDrop?: ;
} | - | Enables column ordering functionality in the table. |
onColumnOrderChange? | (columnOrder: []) => | - | Callback that is called when the column order of any column is changed. |
DataTableV2ColumnOrderControlledProps
Name | Type | Default | Description |
---|---|---|---|
columnOrder? | [] | - | Lets you control the column order of the individual columns. |
DataTableV2ColumnOrderUncontrolledProps
Name | Type | Default | Description |
---|---|---|---|
defaultColumnOrder? | [] | - | Lets you set the initial column order of the individual columns. |
DataTableV2RowOrderBaseProps
Name | Type | Default | Description |
---|---|---|---|
rowOrdering? | | {
/**
* When enabled, a drag handle is be rendered in the first column for every row.
*/
enableDragAndDrop?: ;
} | false | Enables row ordering. |
onRowOrderChange? | (rowOrder: []) => | - | Callback triggered when row order is changed. |
DataTableV2RowOrderControlledProps
Name | Type | Default | Description |
---|---|---|---|
rowOrder? | [] | - | Ordered set of row ids. |
DataTableV2RowOrderUncontrolledProps
Name | Type | Default | Description |
---|---|---|---|
defaultRowOrder? | [] | - | Ordered set of row ids. |
DataTableV2RowSelectionBaseProps
Name | Type | Default | Description |
---|---|---|---|
selectableRows? | | {
/**
* Allows to disable the selection of certain rows.
*/
disableRowSelection?: (row: ) => ;
/**
* Allows to configure if the select all will only select
* the current page or the entire.
* @defaultValue
*/
selectAllBehavior?: | ;
/**
* Allows to set a limit on how m items are allowed
* to be selected. Limit needs to be a positive integer.
*/
limit?: ;
} | false | Enables row selection. Either accepts a boolean to enable the row selection on the entire table. Also accepts a function that will get the row data as the parameter and should return true or false if the row should be selectable or not. |
onRowSelectionChange? | (selectedRows: <, >) => | - | Callback triggered when selection is changed. |
DataTableV2RowSelectionControlledProps
<>
Name | Type | Default | Description |
---|---|---|---|
selectedRows? | <, > | - | Controlled property to define the selected rows. |
DataTableV2RowSelectionUncontrolledProps
<>
Name | Type | Default | Description |
---|---|---|---|
defaultSelectedRows? | <, > | - | Controlled property to define the selected rows. |
DataTableV2ThresholdProps
Name | Type | Default | Description |
---|---|---|---|
rowThresholds? | <>[] | - | Configures the thresholds used for the rows highlighting. |
DataTableV2SubRowsBaseProps
Name | Type | Default | Description |
---|---|---|---|
subRows? | | {
accessor?: // With a keyof we would have type safety for the objects first level and would be able to suggest and ensure that the key given actually exists in the given row data. To support pathed accessors like 'some.nested' we need to fall back to a .
| ((row: ) => [] | );
/**
* Allows to specify a columnId that the subRow indicator will be injected to.
* By default, this will be the first visible column provided by the columns prop.
*/
subRowColumnId?: ;
/**
* Allows to specify a function that will evalute if a specific subRows trigger in a row
* should be disabled.
*/
disableSubRow?: (row: ) => ;
/**
* Defines the behaviour of subrow selection. Default: `cascading`
*
* `cascading`: Selection state of a parent row can be based on the selection state of its children. A parent row cannot be selected on its own and is not included in the `onChange`.
* `individual`: Selection state of a parent row cannot be . A parent can be selected on its own without selected sub-rows.
*
* @defaultValue cascading
*/
selectionBehavior?: | ;
} | false | |
onOpenSubRowsChange? | (openSubRows: <, >) => | - | Callback triggered when open subrows change. |
DataTableV2SubRowsControlledProps
<>
Name | Type | Default | Description |
---|---|---|---|
openSubRows? | true | <, > | - | Currently open sub rows in a controlled scenario. |
DataTableV2SubRowsUncontrolledProps
<>
Name | Type | Default | Description |
---|---|---|---|
defaultOpenSubRows? | true | <, > | - | Initially open sub rows in an uncontrolled scenario. |
DataTableV2RowInteractivityBaseProps
Name | Type | Default | Description |
---|---|---|---|
interactiveRows? | | {
/**
* The `autoActivate` setting controls whether a focused row immediately activates it,
* making stepping through interactive rows with a keyboard more accessible.
* @defaultValue true
*/
autoActivate: ;
} | false | Enables row interactivity. |
onActiveRowChange? | (selectedRows: | , event?: .<> | .<>) => | - | Callback triggered when active row is changed. |
DataTableV2RowInteractivityControlledProps
Name | Type | Default | Description |
---|---|---|---|
activeRow? | | | - | Lets you control the active row. |
DataTableV2RowInteractivityUncontrolledProps
Name | Type | Default | Description |
---|---|---|---|
defaultActiveRow? | | | - | Lets you set the initially active row. |
DataTableV2DownloadProps
Name | Type | Default | Description |
---|---|---|---|
onDownloadData? | (subset: | | ) => | - | Called when table data was downloaded (programmatically or via the toolbar). |
DataTableV2RowIdentification
Name | Type | Default | Description |
---|---|---|---|
rowId? | (row: ) => | - | Enables identification of rows independent of their index in the array. |
DataTableV2.Pagination
Use DataTableV2.Pagination
to enable pagination.
DataTableV2PaginationBaseProps
Name | Type | Default | Description |
---|---|---|---|
id? | - | The element's unique identifier. See MDN. | |
'data-testid'? | - | Test id used for matching the pagination container. | |
pageSizeOptions? | [] | [10, 20, 50, 100, 250, 500, 1000] | Page size options to be displayed in the page size select. |
autoResetPageIndex? | - | Allows opting out of automatic page index reset when new data is being set.
Be aware that if you turn off | |
onPageIndexChange? | (pageIndex: , trigger?: | ) => | - | Called when the page index changes. Provides the changed page index along with the underlying trigger. |
onPageSizeChange? | (pageSize: ) => | - | Handler that is called when the page size changes. |
DataTableV2PaginationPageIndexUncontrolledProps
Name | Type | Default | Description |
---|---|---|---|
defaultPageIndex? | 0 | Initial page index in an uncontrolled scenario. |
DataTableV2PaginationPageIndexControlledProps
Name | Type | Default | Description |
---|---|---|---|
pageIndex | - | Current page index in a controlled scenario. |
DataTableV2PaginationPageSizeUncontrolledProps
Name | Type | Default | Description |
---|---|---|---|
defaultPageSize? | 100 | Default number of rows per page (uncontrolled). |
DataTableV2PaginationPageSizeControlledProps
Name | Type | Default | Description |
---|---|---|---|
pageSize | - | Number of rows per page (controlled) |
DataTableV2PaginationClientSideProps
DataTableV2PaginationServerSideProps
Name | Type | Default | Description |
---|---|---|---|
enablePreviousPage | - | Whether the previous page is available (if not, the go to previous page button should be disabled). | |
enableNextPage | - | Whether the next page is available (if not, the go to next page button should be disabled). | |
totalRowsCount? | - | The total number of rows. Will be used to determine the total number of pages to display the indicator "Page X of Y" for server-side pagination. |
DataTableV2.ColumnActions
Use DataTableV2.ColumnActions
to specify user actions for the table columns.
DataTableV2ColumnActionsProps
Name | Type | Default | Description |
---|---|---|---|
children | | ((column: <>) => <>) | - | |
column? | - | Column id that the given columnactions apply to. If left empty, the given cell actions apply to all columns that allow cell actions. |
DataTableV2.CellActions
Use DataTableV2.CellActions
to specify user actions for the table cells.
DataTableV2CellActionsProps
Name | Type | Default | Description |
---|---|---|---|
children | | ((props: {
columnDef: <>;
cellValue: ;
row: ;
rowId: ;
}) => <>) | - | |
column? | - | Column id that the given cellactions apply to. If left empty, the given cell actions apply to all columns that allow cell actions. |
TableActionsMenu
Use the TableActionsMenu
component for configuring column or cell actions.
This component must be returned by the DataTableV2.ColumnActions
or
DataTableV2.CellActions
function.
TableActionsMenu.ColumnOrder
Use TableActionsMenu.ColumnOrder
inside the TableActionsMenu
to add a menu
item for changing the order of the columns.
TableActionsMenu.LineWrap
Use TableActionsMenu.LineWrap
inside the TableActionsMenu
to add a menu item
for toggling the line wrap of a table column.
TableActionsMenu.ColumnFontStyle
Use TableActionsMenu.ColumnFontStyle
inside the TableActionsMenu
to add a
menu item for toggling the font style of a table column.
TableActionsMenu.HideColumn
Use TableActionsMenu.HideColumn
inside the TableActionsMenu
to add a menu
item for hiding the respective table column.
TableActionsMenu.CopyItem
Use TableActionsMenu.CopyItem
inside the TableActionsMenu
to add a menu item
for copying the cell content to clipboard.
TableActionsMenu.Item
In addition to the predefined actions, you can provide a custom user action
using the TableActionsMenu.Item
subcomponent.
For detailed information about the props check out the
Menu.Item
props.
TableActionsMenu.ItemIcon
Use the TableActionsMenu.ItemIcon
to add an icon to a TableActionsMenu.Item
.
For detailed information about the props check out the
Menu.ItemIcon
props.
TableActionsMenu.Group
Use the TableActionsMenu.Group
to group multiple items in the table actions
menu.
For detailed information about the props check out the
Menu.Group
props.
TableActionsMenu.Label
Use the TableActionsMenu.Label
to add a descriptive label to a table actions
menu group.
For detailed information about the props check out the
Menu.Label
props.
DataTableV2.RowActions
Use DataTableV2.RowActions
to specify user actions for the table rows.
DataTableV2RowActionsProps
Name | Type | Default | Description |
---|---|---|---|
children | (row: , { , , , }: {
: | | ;
: ;
: ;
}) => <> | - |
DataTableV2.SelectedRowsActions
Use DataTableV2.SelectedRowsActions
to define actions that will be applied to
the selected rows. These actions will replace the DataTableV2.TableActions
when one or multiple rows are selected.
DataTableV2SelectedRowsActionsProps
,
Name | Type | Default | Description |
---|---|---|---|
children | (rows: {
rowId: ;
originalRow: ;
}[]) => | - |
DataTableV2.DefaultCell
Custom cell renderer wrapper which automatically deals with applying the correct cell styles.
DataTableV2.EmptyState
Use DataTableV2.EmptyState
to configure a custom empty state that will be
displayed if no data is available.
DataTableV2.TableActions
Use DataTableV2.TableActions
to define general table actions that are
positioned at the top of the DataTableV2
.
DataTableV2.Toolbar
DataTableV2.Toolbar
provides a slot where toolbar components can be added.
DataTableV2.VisibilitySettings
Use DataTableV2.VisibilitySettings
inside the DataTableV2.Toolbar
to render
the trigger for the visibility settings overlay in the toolbar. The overlay
allows the user to control the column visibility for all columns.
DataTableV2VisibilitySettingsProps
Name | Type | Default | Description |
---|---|---|---|
resetColumnVisibility? | - | Column visibility reset state that will be used to reset and also to enable/disable 'Reset to default' in column settings modal. |
DataTableV2.ColumnOrderSettings
Use DataTableV2.ColumnOrderSettings
inside the DataTableV2.Toolbar
to render
the trigger for the column order settings overlay in the toolbar. The overlay
allows the user to control the column order for all columns.
DataTableV2ColumnOrderSettingsProps
Name | Type | Default | Description |
---|---|---|---|
resetColumnOrder? | [] | - | Column order reset state that will be used to reset and also to enable/disable 'Reset to default' in column settings modal. |
DataTableV2.ColumnSettingsTrigger
Use DataTableV2.ColumnSettingsTrigger
inside the DataTableV2.Toolbar
to
customize the label of the trigger for the column settings overlay in the
toolbar.
DataTableV2ColumnSettingsTriggerProps
Name | Type | Default | Description |
---|---|---|---|
children? | (params: {
hiddenColumnCount: ;
totalColumnCount: ;
defaultLabel: ;
}) => | - | Custom label to be displayed in the column settings trigger. |
DataTableV2.DownloadData
Use DataTableV2.DownloadData
inside the DataTableV2.Toolbar
to enable
downloading of the table data. This component contains a menu with the options
for downloading all data, the current page or the selected row data.
DataTableV2.LineWrap
Use DataTableV2.LineWrap
inside the DataTableV2.Toolbar
to add a button for
toggling the line wrap in the table cells.
DataTableV2.SelectionChip
The DataTableV2.SelectionChip
indicates how many rows are currently selected.
DataTableV2.ExpandableRow
Use DataTableV2.ExpandableRow
to define an expandable row template which
provides additional information for each table row.
DataTableV2ExpandableRowBaseProps
Name | Type | Default | Description |
---|---|---|---|
children | (params: {
row: ;
}) => | - | Define a render function as the child of this slot selection to control what is rendered in the expanded row section. |
onExpandedRowsChange? | (expandedRows: <, >) => | - | Callback triggered when the state of the expanded row is changed. |
disableExpand? | (row: ) => | - | Allows you to disable individual rows from expanding by returning true from the passed function. |
DataTableV2ExpandableRowControlledProps
<>
Name | Type | Default | Description |
---|---|---|---|
expandedRows? | true | <, > | - | Controlled state for the expanded rows of the DataTableV2. |
DataTableV2ExpandableRowUncontrolledProps
<>
Name | Type | Default | Description |
---|---|---|---|
defaultExpandedRows? | true | <, > | - | Uncontrolled state for the expanded rows of the DataTableV2. |
DataTableV2.ExpandableRowWrapper
Wrapper helper for DataTableV2.ExpandableRow
that will automatically sync
specific style properties like row padding for rowDensity
variant settings.
DataTableV2ExpandableRowWrapperProps
, <>
DataTableV2Ref
DataTableV2Ref
Name | Type | Default | Description |
---|---|---|---|
element | | | - | Root element ref of the component. |
getConfig | () => | - | Returns the current config of the DataTable. |
downloadData | (subset: | | ) => | - | Downloads all data, the data on the current page or the selected data. |
scrollToRow | (rowId: ) => | - | Scrolls to the row or subRow which matches the given id. |
DataTableV2Config
Current configuration option that can be shared via intents.
DataTableV2Config
Name | Type | Default | Description |
---|---|---|---|
pagination? | {
defaultPageIndex?: ;
defaultPageSize?: ;
} | - | Pagination props to initialize pagination. |
columnVisibility? | [] | - | For specifying which columns should be visible or hidden. |
fullWidth? | <>[] | false | For controlling whether to take up the full parent container width. |
fullHeight? | <>[] | false | For controlling whether to take up the full parent container height. |
lineWrap? | [] | false | For controlling whether the content of a cell should be line wrapped. |
fontStyle? | [] | 'text' | For customizing the font style across the table or within individual columns. |
resizable? | [] | false | For controlling whether the columns are resizable. |
selectableRows? | <>[] | undefined | For controlling whether individual rows can be selected. |
rowThresholds? | <>[] | [] | For configuring the highlighting of individual rows. |
sortable? | [] | false | For controlling whether the columns are sortable. |
variant? | [] | - | For customizing the appearance of the table. |
DataTableV2ColumnDef
Mapping type for the columns prop that can contain either display columns or group columns.
DataTableV2ColumnDef
Signature:
export declare type DataTableV2ColumnDef< extends , = > = <, > | <, >;
DataTableV2RowData
DataTableV2RowData
Signature:
export declare type DataTableV2RowData = | object | [];
DataTableV2AlignmentColumnDef
Extension interface to extend the types of the columnDefinition
from the
TanStack table.
DataTableV2AlignmentColumnDef
Name | Type | Default | Description |
---|---|---|---|
alignment? | | | | | | | | | | - | Defines the text alignment inside the column cell |
DataTableV2SortingColumnDef
Extension interface to extend the types of the columnDefinition
from the
TanStack table.
DataTableV2SortingColumnDef
Name | Type | Default | Description |
---|---|---|---|
disableSorting? | - | Setting to true disables sorting for this column even if sorting is enabled globally. | |
sortType? | | | | | <> | 'text' | Used to compare two rows of data and order them correctly. If a function is passed, it must be memoized. |
sortDescFirst? | - | Setting to true means the first sorting direction for this column will be descending instead of ascending. | |
sortInverted? | - | Setting this to true means the underlying sorting direction will be inverted but the UI will not. This could be useful for example where a lower score is better. | |
sortAccessor? | | ((row: ) => ) | - | Optional - to be used for providing the value used for sorting. This enables the value used for sorting to be different than the value returned by the accessor. For example, if the accessor returns an object, the sortAccessor may return a number or string field within the object. |
DataTableV2ColumnSort
Rule for sorting a column.
DataTableV2ColumnSort
Name | Type | Default | Description |
---|---|---|---|
id | - | Column ID. | |
desc | - | Descending sorting direction. |
DataTableV2ThresholdColumnDef
Extension interface to extend the types of the columnDefinition
from the
TanStack table to support column level thresholds.
DataTableV2ThresholdColumnDef
Name | Type | Default | Description |
---|---|---|---|
thresholds? | <>[] | - | Configures the thresholds used for the cell highlighting. |
DataTableV2ColumnTypesColumnDef
Combined ruleset of column types and their matching configurations.
DataTableV2ColumnTypesColumnDef
Signature:
export declare type sColumnDef = {
columnType: <, >;
config?: ;
} | {
columnType: <, >;
config?: ;
} | {
columnType: <, >;
formatter?: ;
config?: ;
} | {
columnType: <, >;
formatter?: ;
config?: ;
} | {
columnType?: <, | >;
formatter?: <, >;
config?: ;
} | {
columnType: <, >;
formatter?: <<, >, | | | | | >;
config?: ;
} | {
columnType: <, >;
config?: ;
} | {
columnType?: <, >;
formatter?: ;
config?: ;
} | {
columnType: <, >;
formatter?: ;
config?: ;
} | {
columnType: <, >;
formatter?: <, >;
config?: ;
};
DataTableV2ColumnType
Available column types for the DataTableV2.
DataTableV2ColumnType
Signature:
export declare type DataTableV2ColumnType = | | | | | | | | | | ;
DataTableV2CellFormatter
DataTableV2 column definition formatter options.
DataTableV2CellFormatter
Signature:
export declare type DataTableV2CellFormatter = <, > | | ;
DataTableV2LineWrapState
Defines the shape of the LineWrap state within the TanStack tables state.
DataTableV2LineWrapState
Signature:
export declare type DataTableV2LineWrapState = <, > | ;
DataTableV2GlobalLineWrapAction
Global line wrap action for the DataTableV2 to be used in the DataTableV2.Toolbar.
DataTableV2ColumnFontStyleState
Defines the shape of the FontStyle state within the TanStack tables state.
DataTableV2ColumnFontStyleState
Signature:
export declare type DataTableV2ColumnFontStyleState = <, | >;
DataTableV2ColumnSizingState
DataTableV2 columnSizing state represented with a columnId key and a pixel size value.
DataTableV2ColumnSizingState
Signature:
export declare type DataTableV2ColumnSizingState = <, >;
DataTableV2ThresholdRule
Threshold configuration that can be applied to highlight something matching the id.
DataTableV2ThresholdRule
Signature:
export declare type DataTableV2ThresholdRule< extends > = {
comparator: | | | | | ;
value: ;
/** Accessor or function to pick the value from the rowData that should be compared against. */
accessor?: | ((row: ) => );
} | {
/** The operator being used to compare the object value with the threshold value. */
comparator: | ;
/** The threshold value to compare the object value to. */
value: ;
/** Accessor or function to pick the value from the rowData that should be compared against. */
accessor?: | ((row: ) => );
} | {
/** Custom comparator function that is called with the row data. */
comparator: (rowData: ) => ;
};
DataTableV2RowThreshold
Threshold configuration that can be applied to highlight something matching the id.
DataTableV2RowThreshold
Signature:
export declare type DataTableV2RowThreshold< extends > = <> | <>;
DataTableV2ColumnThreshold
Threshold configuration that can be applied to highlight something matching the id.
DataTableV2ColumnThreshold
Signature:
export declare type DataTableV2ColumnThreshold< extends > = <> | <>;
DataTableV2SingleRowThreshold
Threshold configuration that can be applied to highlight something matching the id.
DataTableV2SingleRowThreshold
Signature:
export declare type DataTableV2SingleRowThreshold< extends > = <> & {
rules?: ;
} & ({
type: ;
color: ;
} | {
type: ;
backgroundColor?: ;
color?: ;
});
DataTableV2CombinedRowThresholds
Threshold configuration that can be applied to highlight something matching the id.
DataTableV2CombinedRowThresholds
Signature:
export declare type DataTableV2CombinedRowThresholds< extends > = {
rules: <>[];
} & ({
type: ;
color: ;
} | {
type: ;
backgroundColor?: ;
color?: ;
});
DataTableV2ColumnVisibilityState
Configuration object for the column visibility state. To define the column visibility for a column, provide the column ID along with the desired boolean value.
DataTableV2ColumnVisibilityState
Signature:
export declare type DataTableV2ColumnVisibilityState = <, >;
DataTableV2VisibilityColumnDef
Extension interface to extend the types of the columnDefinition from the TanStack table.
DataTableV2VisibilityColumnDef
Name | Type | Default | Description |
---|---|---|---|
disableColumnHiding? | - | Controls the ability of the given column to toggle it's visibility. This setting will affect if the column will be hidable in column actions or via the modal controls of the DataTableV2 toolbar. |
DataTableV2Download
DataTableV2 slot definition for the Download action.
DataTableV2DownloadProps
Name | Type | Default | Description |
---|---|---|---|
onDownloadData? | (subset: | | ) => | - | Called when table data was downloaded (programmatically or via the toolbar). |