@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
44 lines (43 loc) • 2.15 kB
JavaScript
'use client';
import '@ui5/webcomponents/dist/TableGroupRow.js';
import { withWebComponent } from '@ui5/webcomponents-react-base';
/**
* The `TableGroupRow` component represents a group header row in the `Table`.
* It is used to visually group rows and spans across all visible table columns.
*
* ### Usage
*
* The `TableGroupRow` is placed as a direct child of `Table`, alongside `TableRow` elements.
* Rows following a group row are considered part of that group until the next group row.
*
* ```html
* <Table>
* <TableHeaderRow>...</TableHeaderRow>
* <TableGroupRow>Country: Germany</TableGroupRow>
* <TableRow>...</TableRow>
* <TableRow>...</TableRow>
* <TableGroupRow>Country: France</TableGroupRow>
* <TableRow>...</TableRow>
* </Table>
* ```
*
* ### Unsupported Features
*
* The following features of `TableRow` are currently not supported by `TableGroupRow` and have no effect:
*
* - **Cells** (`cells` slot): Group rows render a single spanning cell with a text. Any slotted `TableCell` elements are ignored.
* - **Actions** (`actions` slot): Row actions such as `TableRowAction` or `TableRowActionNavigation` are not rendered.
* - **Navigation** (`navigated` property): The navigated indicator is not rendered on group rows.
* - **Interactive** (`interactive` property): Group rows do not support click/activation behavior.
* - **Selection** (`rowKey` property`): Group rows cannot be selected. They are excluded from select all and range selection operations.
* - **Virtualizer** (`position` property`): Group rows are not supported by the `TableVirtualizer`.
*
*
*
* __Note:__ This is a UI5 Web Component! [TableGroupRow UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableGroupRow) | [Repository](https://github.com/UI5/webcomponents)
*
* @since [2.23.0](https://github.com/UI5/webcomponents/releases/tag/v2.23.0) of __@ui5/webcomponents__.
*/
const TableGroupRow = withWebComponent('ui5-table-group-row', ['position', 'rowKey'], ['interactive', 'movable', 'navigated'], ['actions'], []);
TableGroupRow.displayName = 'TableGroupRow';
export { TableGroupRow };