Support merge/col span cells horizontal in grid and hide a column #4050
Open
lassopicasso wants to merge 7 commits intomainfrom
Open
Support merge/col span cells horizontal in grid and hide a column #4050lassopicasso wants to merge 7 commits intomainfrom
lassopicasso wants to merge 7 commits intomainfrom
Conversation
Contributor
📝 WalkthroughWalkthroughThis change introduces column-level visibility and span support to the Grid component. A new Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
JamalAlabdullah
changed the title
JamalAlabdullah
added
kind/product-feature
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (3)
src/layout/Grid/tools.ts (1)
109-117: Consider reducing type casting by leveraging existing type guards.The function uses
astype casting which the coding guidelines recommend avoiding. Since all non-nullGridCellvariants (GridCellText,GridCellLabelFrom,GridComponentRef) have the same optionalcolumnOptionsandgridColumnOptionsproperties, you could use the existing type guards to narrow the type.♻️ Suggested refactor using type guards
export function getGridCellHiddenExpr(cell: GridCell) { if (!cell || typeof cell !== 'object') { return undefined; } - const options = - 'columnOptions' in cell ? (cell as { columnOptions?: { hidden?: unknown } }).columnOptions : undefined; - const gridOpts = - 'gridColumnOptions' in cell ? (cell as { gridColumnOptions?: { hidden?: unknown } }).gridColumnOptions : undefined; - return gridOpts?.hidden ?? options?.hidden; + if (isGridCellText(cell) || isGridCellLabelFrom(cell) || isGridCellNode(cell)) { + return cell.gridColumnOptions?.hidden ?? cell.columnOptions?.hidden; + } + return undefined; }As per coding guidelines: "Avoid using
anyor type casting (as type) in TypeScript; instead, improve typing by removing such casts andanys to maintain proper type safety."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/layout/Grid/tools.ts` around lines 109 - 117, getGridCellHiddenExpr currently uses 'as' casts to access columnOptions/gridColumnOptions; instead use the existing type guards to narrow GridCell (e.g., isGridCellText, isGridCellLabelFrom, isGridComponentRef or whatever project's guards are named) and then read cell.columnOptions and cell.gridColumnOptions directly without casting, returning gridColumnOptions?.hidden ?? columnOptions?.hidden; remove the two '(cell as {...})' casts and the initial typeof check since the type guards handle null/undefined checks.src/layout/Grid/GridComponent.tsx (2)
255-260: Apply the same optional chaining and type safety improvements here.This section has the same pattern as the text/label cell handling and should be refactored similarly.
♻️ Suggested refactor
- const cellColSpan = (cell as { colSpan?: number } | null)?.colSpan; - if (cellColSpan !== undefined) { + const cellColSpan = cell && 'colSpan' in cell ? cell.colSpan : undefined; + if (cellColSpan !== undefined) { componentCellSettings = componentCellSettings ? { ...componentCellSettings, colSpan: cellColSpan } : { colSpan: cellColSpan }; }As per coding guidelines: "Avoid using
anyor type casting (as type) in TypeScript."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/layout/Grid/GridComponent.tsx` around lines 255 - 260, The code uses a type cast and manual null checks for colSpan; change to use optional chaining and a proper narrow type or type guard instead of "as". Replace the current block in GridComponent (where cellColSpan and componentCellSettings are set) with a check using cell?.colSpan (e.g., if (cell?.colSpan !== undefined) { componentCellSettings = componentCellSettings ? { ...componentCellSettings, colSpan: cell.colSpan } : { colSpan: cell.colSpan }; }) or introduce a CellWithColSpan interface and a small type guard function to ensure type-safe access to colSpan, avoiding any casts and preserving the existing merge logic for componentCellSettings.
203-208: Use optional chaining and reduce type casting.The SonarCloud analysis correctly identifies that optional chaining would be cleaner. Additionally, the
astype casting could be avoided by using a more type-safe approach.♻️ Suggested refactor
- const cellWithColSpan = cell as { colSpan?: number } | null; - if (cellWithColSpan && cellWithColSpan.colSpan !== undefined) { - textCellSettings = textCellSettings - ? { ...textCellSettings, colSpan: cellWithColSpan.colSpan } - : { colSpan: cellWithColSpan.colSpan }; - } + const cellColSpan = 'colSpan' in cell ? cell.colSpan : undefined; + if (cellColSpan !== undefined) { + textCellSettings = textCellSettings + ? { ...textCellSettings, colSpan: cellColSpan } + : { colSpan: cellColSpan }; + }As per coding guidelines: "Avoid using
anyor type casting (as type) in TypeScript."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/layout/Grid/GridComponent.tsx` around lines 203 - 208, Replace the ad-hoc type cast and manual null check with a type-safe user-defined type guard and optional chaining: add a small type guard function (e.g., hasColSpan(obj: unknown): obj is { colSpan?: number }) that checks obj is non-null object and has the 'colSpan' property, then use if (hasColSpan(cell) && cell.colSpan !== undefined) { textCellSettings = textCellSettings ? { ...textCellSettings, colSpan: cell.colSpan } : { colSpan: cell.colSpan }; } so you remove the "as" cast and use optional access via the guard when updating textCellSettings in GridComponent (reference symbols: hasColSpan, textCellSettings, cell).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/layout/Grid/GridComponent.tsx`:
- Around line 255-260: The code uses a type cast and manual null checks for
colSpan; change to use optional chaining and a proper narrow type or type guard
instead of "as". Replace the current block in GridComponent (where cellColSpan
and componentCellSettings are set) with a check using cell?.colSpan (e.g., if
(cell?.colSpan !== undefined) { componentCellSettings = componentCellSettings ?
{ ...componentCellSettings, colSpan: cell.colSpan } : { colSpan: cell.colSpan };
}) or introduce a CellWithColSpan interface and a small type guard function to
ensure type-safe access to colSpan, avoiding any casts and preserving the
existing merge logic for componentCellSettings.
- Around line 203-208: Replace the ad-hoc type cast and manual null check with a
type-safe user-defined type guard and optional chaining: add a small type guard
function (e.g., hasColSpan(obj: unknown): obj is { colSpan?: number }) that
checks obj is non-null object and has the 'colSpan' property, then use if
(hasColSpan(cell) && cell.colSpan !== undefined) { textCellSettings =
textCellSettings ? { ...textCellSettings, colSpan: cell.colSpan } : { colSpan:
cell.colSpan }; } so you remove the "as" cast and use optional access via the
guard when updating textCellSettings in GridComponent (reference symbols:
hasColSpan, textCellSettings, cell).
In `@src/layout/Grid/tools.ts`:
- Around line 109-117: getGridCellHiddenExpr currently uses 'as' casts to access
columnOptions/gridColumnOptions; instead use the existing type guards to narrow
GridCell (e.g., isGridCellText, isGridCellLabelFrom, isGridComponentRef or
whatever project's guards are named) and then read cell.columnOptions and
cell.gridColumnOptions directly without casting, returning
gridColumnOptions?.hidden ?? columnOptions?.hidden; remove the two '(cell as
{...})' casts and the initial typeof check since the type guards handle
null/undefined checks.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 67925669-d359-425d-a239-078444973770
📒 Files selected for processing (5)
src/codegen/Common.tssrc/layout/Grid/GridComponent.test.tsxsrc/layout/Grid/GridComponent.tsxsrc/layout/Grid/tools.test.tssrc/layout/Grid/tools.ts
JamalAlabdullah
added
the
squad/utforming
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
In this PR we extended
GridComponent.tsxto support;colSpanon both text/label and component cells, so a cell can span multiple columns.What is implemented
colSpansupport for grid cellsWe added
colSpantoIGridColumnPropertiesinCommon.tsThis makes it possible to set
colSpandirectly on the cell:{ "text": "Header 1", "colSpan": 2 }or via "gridColumnOptions": { "colSpan": 2 }colSpan: We merge headercolumnOptions, per‑cellgridColumnOptions, and any cell‑levelcolSpanintocolumnStyleOptions, then evaluatecolumnStyleOptions.colSpanwithuseEvalExpressionand pass the result as the<th>/<td>colSpanso both text/label and component cells can span multiple columns.We added a
hiddenproperty toIGridColumnProperties, aligned withITableColumnProperties.hidden:This allows header cells to define visibility:
"text": "heading2","gridColumnOptions": { "hidden": false }Grid/tools.tscalledgetGridCellHiddenExprsmall helper that It returns the cell’s hidden expression, usinggridColumnOptions.hiddenif present, otherwise columnOptions.hidden.NOTE:
After:
Screen.Recording.2026-03-17.at.12.47.48.mov
Related Issue(s)
Verification/QA
kind/*andbackport*label to this PR for proper release notes grouping