Skip to content

docs: mark compat/Table as deprecated #11792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions packages/compat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@

[![npm Package Version](https://badge.fury.io/js/%40ui5%2Fwebcomponents.svg)](https://www.npmjs.com/package/@ui5/webcomponents)

Provides Table web component for compatibility (previously part of the "@ui5/webcomponents" package), while brand new Table web component is being developed and will replace it in the "@ui5/webcomponents" package.
**DEPRECATED SINCE 2.12.0:** The `@ui5/webcomponents-compat` package has been deprecated as of version `2.12.0`.
Please use the Table from `@ui5/webcomponents` package instead.

While `@ui5/webcomponents-compat` will remain available for compatibility purposes (until the next major release),
migration is strongly recommended, as new development and enhancements will be focused on `@ui5/webcomponents/Table`.

**Note:** The package is available since 2.0 and will be available until the next major release (3.0) when it will be removed as the Table "@ui5/webcomponents" will finally replace it.
## Provided components

The package provides Table web component and several subcomopnents as descrived below.

## Provided components

| Web Component | Tag name | Module import |
|--------------------------|-----------------------------|------------------------------------------------------------|
Expand Down
1 change: 1 addition & 0 deletions packages/compat/src/Table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ enum TableFocusTargetElement {
* @constructor
* @extends UI5Element
* @public
* @deprecated Deprecated as of version 2.12.0, use `@ui5/webcomponents/dist/Table.js` instead.
*/
@customElement({
tag: "ui5-table",
Expand Down
1 change: 1 addition & 0 deletions packages/compat/src/TableCell.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
* @extends UI5Element
* @public
* @csspart cell - Used to style the native `td` element
* @deprecated Deprecated as of version 2.12.0, use `@ui5/webcomponents/dist/TableCell.js` instead.
*/
@customElement({
tag: "ui5-table-cell",
Expand Down
1 change: 1 addition & 0 deletions packages/compat/src/TableColumn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import tableColumnStyles from "./generated/themes/TableColumn.css.js";
* @public
* @slot {Node[]} default - Defines the content of the column header
* @csspart column - Used to style the native `th` element
* @deprecated Deprecated as of version 2.12.0, use `@ui5/webcomponents/dist/Table.js` instead.
*/
@customElement({
tag: "ui5-table-column",
Expand Down
1 change: 1 addition & 0 deletions packages/compat/src/TableGroupRow.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import tableGroupRowStyles from "./generated/themes/TableGroupRow.css.js";
*
* **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
* @csspart group-row - Used to style the native `tr` element
* @deprecated Deprecated as of version 2.12.0, use `@ui5/webcomponents/dist/Table.js` instead.
*/
@customElement({
tag: "ui5-table-group-row",
Expand Down
1 change: 1 addition & 0 deletions packages/compat/src/TableRow.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ type TableRowF7PressEventDetail = {
* @public
* @csspart row - Used to style the native `tr` element
* @csspart popin-row - Used to style the `tr` element when a row pops in
* @deprecated Deprecated as of version 2.12.0, use `@ui5/webcomponents/dist/TableRow.js` instead.
*/
@customElement({
tag: "ui5-table-row",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,6 @@ import SingleSelection from "../../../_samples/compat/Table/SingleSelection/Sing
import MultipleSelection from "../../../_samples/compat/Table/MultipleSelection/MultipleSelection.md";
import StickyHeader from "../../../_samples/compat/Table/StickyHeader/StickyHeader.md";

:::info
The **@ui5/webcomponents-compat** package is introduced since 2.0 and includes the Table web component
that was previously part of the main **@ui5/webcomponents** package in version 1.x.
It has been replaced by brand new Table web component implementation, availabe since 2.0 in **@ui5/webcomponents** package.
The current one, in **@ui5/webcomponents-compat**, is kept for compatibility.
:::

<%COMPONENT_OVERVIEW%>

## Basic Sample
Expand Down
Loading