Skip to content

chore(DescriptionList): Include OUIAProps for DescriptionList#12595

Open
mshriver wants to merge 1 commit into
patternfly:mainfrom
mshriver:description-list-ouia
Open

chore(DescriptionList): Include OUIAProps for DescriptionList#12595
mshriver wants to merge 1 commit into
patternfly:mainfrom
mshriver:description-list-ouia

Conversation

@mshriver

@mshriver mshriver commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Add OUIA attribute support to DescriptionList for better test automation.

What:
Closes #12594

Summary by CodeRabbit

  • New Features

    • Added OUIA support to the Description List component.
    • Added optional identifiers and safety settings for improved UI automation and testing.
    • Description Lists now expose standardized OUIA attributes in the rendered markup.
  • Documentation

    • Added Description List to the list of OUIA-compliant components.

Add OUIA attribute support to DescriptionList for better test automation.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a2f249a5-7254-44b9-ae4b-5e2d97fc7294

📥 Commits

Reviewing files that changed from the base of the PR and between c4086a0 and f9c85a6.

⛔ Files ignored due to path filters (1)
  • packages/react-core/src/components/DescriptionList/__tests__/__snapshots__/DescriptionList.test.tsx.snap is excluded by !**/*.snap
📒 Files selected for processing (3)
  • packages/react-core/src/components/DescriptionList/DescriptionList.tsx
  • packages/react-core/src/components/DescriptionList/__tests__/DescriptionList.test.tsx
  • packages/react-core/src/helpers/OUIA/OUIA.md

Walkthrough

DescriptionList now accepts OUIA props, applies generated OUIA attributes to its <dl> element, tests the resulting behavior, and lists the component in OUIA documentation.

Changes

DescriptionList OUIA support

Layer / File(s) Summary
Add OUIA props and root attributes
packages/react-core/src/components/DescriptionList/DescriptionList.tsx
DescriptionListProps now includes OUIAProps; the component defaults ouiaSafe to true, computes OUIA attributes, and applies them to the rendered list.
Validate and document OUIA support
packages/react-core/src/components/DescriptionList/__tests__/DescriptionList.test.tsx, packages/react-core/src/helpers/OUIA/OUIA.md
Tests cover custom IDs, component type, and safe-mode values; OUIA documentation now lists DescriptionList.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: rebeccaalpert, thatblindgeye

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding OUIA props support to DescriptionList.
Linked Issues check ✅ Passed DescriptionList now accepts and applies OUIA props, matching the linked issue's request for OUIA support.
Out of Scope Changes check ✅ Passed The tests and docs updates are supporting changes for the OUIA work and do not appear unrelated.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

DescriptionList missing OUIA Support

1 participant