ui: document table cell wrapper requirement

Added TSDoc comments to ColumnConfig.cell, RowRenderFn, CellProps,
CellTextProps, and CellProfileProps making it explicit that cell render
functions must return a cell component (Cell, CellText, or CellProfile)
as the top-level element. Also added a Table Cell Requirement section
to the package README with correct and incorrect usage examples.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
This commit is contained in:
Patrik Oldsberg
2026-03-16 20:16:25 +01:00
parent 3f2788e1ef
commit 872dc1025e
4 changed files with 117 additions and 17 deletions
@@ -0,0 +1,7 @@
---
'@backstage/ui': patch
---
Documented the requirement that `ColumnConfig.cell` and custom `RowRenderFn` renders must return a cell component (`Cell`, `CellText`, or `CellProfile`) as the top-level element.
Affected components: Table, Cell, CellText, CellProfile