Skip to content

fix(ui): remove redundant inner Description card on Domain & Data Product docs#30338

Open
siddhant1 wants to merge 1 commit into
open-metadata:mainfrom
siddhant1:remove-description-outer-card
Open

fix(ui): remove redundant inner Description card on Domain & Data Product docs#30338
siddhant1 wants to merge 1 commit into
open-metadata:mainfrom
siddhant1:remove-description-outer-card

Conversation

@siddhant1

@siddhant1 siddhant1 commented Jul 22, 2026

Copy link
Copy Markdown
Member

What

On the Documentation tab of Domain and Data Product detail pages, the Description now renders as a single, clean card — the header and text sit flush inside the standard left‑panel frame with even padding.

Previously the Description was wrapped in two nested cards: the standard left‑panel frame and the Description's own wrapInCard box (its own border + shadow + 18px padding). Because both of these pages place the Description as the sole child of the left panel, that inner card simply duplicated the frame — producing a double border and an uneven gap at the bottom.

How

  • Added an optional wrapDescriptionInCard prop to CommonWidgets (defaults to true, so every other entity type is unchanged).
  • The Domain and Data Product widget dispatchers (getDomainWidgetsFromKey, getDataProductWidgetsFromKey) now pass wrapDescriptionInCard={false}.

Tables / dashboards / etc. keep their inner Description card — their left panel legitimately wraps multiple sections (Description and Schema) — so this change is scoped strictly to Domain + Data Product.

Before / After

Domain

Before After

Data Product

Before After

Testing

  • UI checkstyle (organize‑imports → eslint → prettier) runs clean on all changed files.
  • Verified live on a local dev server against both the Domain and Data Product Documentation tabs (screenshots above). The Description container's computed style goes from border: 1px / box-shadow / padding: 18px (inner card) to border: 0 / no shadow / padding: 0 (flush inside the frame).
  • Existing Jest specs mock Description and don't assert on wrapInCard, so they are unaffected.

🤖 Generated with Claude Code

Greptile Summary

This PR removes the redundant inner Description card on Domain and Data Product documentation pages. The main changes are:

  • Adds a configurable Description-card wrapper to CommonWidgets.
  • Preserves card wrapping by default for existing callers.
  • Disables the inner card for Domain and Data Product widgets.

Confidence Score: 5/5

The default layouts look safe, with a non-blocking visual regression possible in customized layouts.

  • Existing callers retain the previous wrapped-card behavior by default.
  • Memo dependencies correctly track the new prop.
  • A standalone customized Description can lose all card framing.

DomainUtils.tsx and DataProductUtils.tsx

Important Files Changed

Filename Overview
openmetadata-ui/src/main/resources/ui/src/components/DataAssets/CommonWidgets/CommonWidgets.tsx Adds a backward-compatible wrapper prop and correctly includes it in the memo dependencies.
openmetadata-ui/src/main/resources/ui/src/utils/DomainUtils.tsx Disables the Description card for Domain widgets without considering customized widget placement.
openmetadata-ui/src/main/resources/ui/src/utils/DataProductUtils.tsx Applies the same placement-independent Description-card override to Data Product widgets.

Reviews (1): Last reviewed commit: "fix(ui): drop redundant inner Descriptio..." | Re-trigger Greptile

Greptile also left 1 inline comment on this PR.

Context used (3)

  • Context used - openmetadata-ui-core-components/CLAUDE.md (source)
  • Context used - CLAUDE.md (source)
  • Context used - AGENTS.md (source)

…ct docs

The Documentation tab on Domain and Data Product detail pages rendered the
Description inside two nested cards - the standard left-panel frame and the
Description's own wrapInCard box - producing a double border and an uneven
bottom gap. Both pages place the Description as the sole child of the left
panel, so the inner card just duplicates the frame.

Add an optional wrapDescriptionInCard prop to CommonWidgets (default true, so
every other entity type is unchanged) and pass false from the Domain and Data
Product widget dispatchers. The Description now sits flush inside the single
left-panel frame with even padding.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 22, 2026 08:52
@siddhant1
siddhant1 requested a review from a team as a code owner July 22, 2026 08:52

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

Copy link
Copy Markdown
Contributor

❌ PR checklist incomplete

This PR cannot be merged until the following are addressed on its linked issue:

  • No GitHub issue is linked. Link an issue in the Development section of the PR (or add Fixes #12345 to the description). For a same-org cross-repo issue, add Fixes open-metadata/<repo>#123 to the description.

The fields live on the linked issue in the Shipping project (open the issue → right sidebar → Projects). After you set them, re-run this check (or push a commit) — issue/project changes do not re-trigger it automatically.

Maintainers can bypass this check by adding the skip-pr-checks label.

@github-actions

Copy link
Copy Markdown
Contributor

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

@gitar-bot

gitar-bot Bot commented Jul 22, 2026

Copy link
Copy Markdown
Code Review ✅ Approved

Removes the redundant nested card wrapper from Domain and Data Product documentation panels by introducing a conditional prop in CommonWidgets. This creates a clean, flush layout without affecting other entity types.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@siddhant1 siddhant1 added UI UI specific issues safe to test Add this label to run secure Github workflows on PRs labels Jul 22, 2026
Comment thread openmetadata-ui/src/main/resources/ui/src/utils/DomainUtils.tsx
@siddhant1 siddhant1 added the skip-pr-checks Bypass PR metadata validation check label Jul 22, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Jest test Coverage

UI tests summary

Lines Statements Branches Functions
Coverage: 65%
65.24% (75954/116407) 49.03% (45278/92347) 49.87% (13695/27460)

@sonarqubecloud

Copy link
Copy Markdown

@siddhant1
siddhant1 enabled auto-merge July 22, 2026 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to test Add this label to run secure Github workflows on PRs skip-pr-checks Bypass PR metadata validation check UI UI specific issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants