🚀 Feature: Better documentation for sorting and paginating for Table

[dariozachow]

🔖 Feature description

It is really hard to use the Table Component by Backstage, within your own plugin, because there are no docs for showing how this thing works. The types provided by Table or not really good documented as well.

🎤 Context

I was trying simple things like custom sorting and server side pagination with the table but failed when trying. When looking in the backstage code I found that this is possible but not that easy as I'm not a frontend dev primarily. Therefore it would be really helpful to have some guidance in how to do such things.

✌️ Possible Implementation

Update the docs and explain how to do certain things with it. The only thing I found was https://backstage.io/docs/reference/core-components.table/ and the storybook.

👀 Have you spent some time to check if this feature request has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Are you willing to submit PR?

No, but I'm happy to collaborate on a PR with someone else

[dariozachow]

Still struggling with implementing this 😓

[vinzscam]

we do something similar in

backstage/plugins/catalog/src/components/CatalogTable/PaginatedCatalogTable.tsx

Line 4 in 32cc4e6

* Licensed under the Apache License, Version 2.0 (the "License");

when paginating server side, you want to try to minimize the logic used from the Table component, as everything will be handled server side (on your side). Under the hood, the Table component uses https://material-table-core.github.io/ and all the props are inherited.

[dariozachow]

Thanks for your answer. I already looked at the paginated Table, but when using the same settings/options for the table the pagination buttons were not clickable. This was kinda confusing and I could not figure out why.

I'll take a look into the material table soon.

[vinzscam]

ok, keep attention to the page and totalCount props as they are the two props that enable the pagination buttons (it was a small hack 😅)

[dariozachow]

Thanks for the input, I'll try that soon.