Skip to content

docs(ui5-table): add first blog draft #11232

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(ui5-table): add first blog draft #11232

wants to merge 1 commit into from

Conversation

DonkeyCo
Copy link
Member

@DonkeyCo DonkeyCo commented Apr 1, 2025

DO NOT MERGE YET!

This is a first draft for the blog post announcing the stable release of the ui5-table.

The following points are mentioned in the blog post:

  1. Motivation: Accessibility, Harmonization, API + New Ideas
  2. Mentioning New Introductions: Table + ARIA structure, Keyboard Handling, Feature Concept, New Features and Functionalities
  3. Upcoming Features


# The Table Web Component is Now Stable - Here's What's New

After its half year tenure as experimental component since the relase of UI5 Web Components 2.0, allowing us to gather feedback
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

relase => release
I usually use this tool https://www.grammarly.com/ or something similar to detect all kinds of typos and grammar mistakes before publishing

@DonkeyCo DonkeyCo requested review from aborjinik, simlin and KvM2 April 1, 2025 12:36
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should not be the way how virtualizer work

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose you want a sample with extra rows? Maybe we should adjust the playground sample as well then (as the gif is taken from there)


### Keyboard Handling

Apart from moving the ARIA roles from the Shadow DOM to the "light" DOM, allowing you to directly reference other components via `aria-labelledby`, accessibility
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe mention that the root is the exception?


While these new features and functionalities are already quite a lot, we already have additional features planned for the future.

Here is a quick sneak peek on what is about to come:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about this section. All these points are currently on the requirements list. But when and in which way they might be available in future depends on many factors. This list could create expectations what's coming next.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need a similar list for the ui5con or we should from that section from the ui5con session

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with omitting this part from the blog. I'll think about replacing this maybe with a short migration sample

Back in UI5 Web Components 1.x, the library already offered a Table component, which provided developers with capabilities to display
data in a tabular structure.

As we've decided to upgrade the component library to 2.0, the Table component was reevaluated and we've identified pain points, the biggest
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should try to formulate it positive and do so much finger pointing to the old table.

Maybe something like

With UI5 2.0 we decided to reevaluate our Table component by taking accessibility principles and the harmonization with the existing table types in OpenUI5 as fundaments.

Katja has maybe some suggestion as well :)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree this type of text can and should be positive but I also believe that restrictions should be made transparent if they exist. Here, I think the text describes the process rather than the result and I would leave that part out and start the second sentence in this section with the three points that have been changed/improved.

Copy link
Collaborator

@KvM2 KvM2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments mostly related to textual matters. I wasn't sure how much information about the "old" table should be included in such a blog.


# The Table Web Component is Now Stable - Here's What's New

After its half year tenure as experimental component since the relase of UI5 Web Components 2.0, allowing us to gather feedback
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After its half year tenure as experimental component since the relase of UI5 Web Components 2.0, allowing us to gather feedback
After its half-year tenure as an experimental component since the release of UI5 Web Components 2.0, allowing us to gather feedback

and improve upon the API, the Table component will finally leave its experimental state!

This blog will update you on why we've decided to take this path, the improvements and new features of the `ui5-table`
and will give you a rough idea of migration.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
and will give you a rough idea of migration.
, and it will give you a rough idea of the migration.


Upgrading to a new version gave us the chance to reassess and reimagine the component, allowing us to focus on three core points:
1. Improve Accessibility
2. Harmonize Web Component Table and UI5 Tables
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Harmonize Web Component Table and UI5 Tables
2. Harmonize the Table component and the equivalent UI5 tables

and often times differing from its counterpart.

Upgrading to a new version gave us the chance to reassess and reimagine the component, allowing us to focus on three core points:
1. Improve Accessibility
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Improve Accessibility
1. Improve accessibility

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Idea: It might be better to stress what has been done : Improved accessibility ... and so on

date: 2025-03-26T10:00
---

# The Table Web Component is Now Stable - Here's What's New
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably say "productive" or "no longer experimental" or something. As a reader, I would take it as a given that it is also stable. Downside is this is a bit long. 🤔

in the overflow behavior of your table.

Furthermore, the "popin configuration" has changed. Instead of defining a `minWidth` representing the "minimum table width", you can define `width` or `minWidth` for the
column itself. Once the table overflows, the columns overflowing, e.g. not fitting into the table anymore, will be moved into the "popin area". This is a more natural
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
column itself. Once the table overflows, the columns overflowing, e.g. not fitting into the table anymore, will be moved into the "popin area". This is a more natural
column itself. If the table overflows, the columns that overflow, for example, if they don't fit into the table anymore, will be moved into the "popin area". This is a more natural


Furthermore, the "popin configuration" has changed. Instead of defining a `minWidth` representing the "minimum table width", you can define `width` or `minWidth` for the
column itself. Once the table overflows, the columns overflowing, e.g. not fitting into the table anymore, will be moved into the "popin area". This is a more natural
overflow behavior, allowing you to just define the widths of your columns without worrying about the general table width.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
overflow behavior, allowing you to just define the widths of your columns without worrying about the general table width.
overflow behavior allowing you to just define the widths of your columns without worrying about the general table width.

The `ui5-table` and its related components (except for `TableVirtualizer`) are finally graduating from their experimental state and will move into a stable state.
The new table offers new and improved features, accessibility and user experience.

For compatibility reasons, the old table is still available in the `compat` package, but please migrate to the new Table implementation to leverage the newest
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For compatibility reasons, the old table is still available in the `compat` package, but please migrate to the new Table implementation to leverage the newest
For compatibility reasons, the old table is still available in the `compat` package, but please migrate to the new table implementation to leverage the newest

For compatibility reasons, the old table is still available in the `compat` package, but please migrate to the new Table implementation to leverage the newest
features and functionalities.

If you are interested in learning more about the `ui5-table`, check the [documentation](https://sap.github.io/ui5-webcomponents/components/Table/) or join
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To stress this more, you could say: check out the documentation

For compatibility reasons, the old table is still available in the `compat` package, but please migrate to the new Table implementation to leverage the newest
features and functionalities.

If you are interested in learning more about the `ui5-table`, check the [documentation](https://sap.github.io/ui5-webcomponents/components/Table/) or join
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you are interested in learning more about the `ui5-table`, check the [documentation](https://sap.github.io/ui5-webcomponents/components/Table/) or join
If you are interested in learning more about the `ui5-table`, check the [documentation](https://sap.github.io/ui5-webcomponents/components/Table/), or join

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants