Repository navigation
[feat]: Create <pf-v6-description-list> element #2931
Copy link
Copy link
Open
Labels
1:1Aligning components with PatternFly v4Aligning components with PatternFly v4good 1st issueGood for newcomers to the project; requires at least an introductory knowledge of the languageGood for newcomers to the project; requires at least an introductory knowledge of the languagepriority: lowSeverity level: 3Severity level: 3
Milestone
Description
Summary
Create `` to implement the PatternFly v6 Description list component.
Semantic `
- ` pattern for displaying term/value pairs with layout variants.
- MUST implement PFv6 visual designs
- MUST provide end-user feature parity with `@patternfly/react-core` DescriptionList
- MAY adjust element API to leverage web platform strengths
- SHOULD maintain CSS custom property theming compatibility
- SHOULD expose useful CSS shadow parts
- Must render as native `
- `/`
- `/`
- ` for semantic correctness
- React `isHorizontal` - term and value side-by-side; map to `horizontal` attribute
- React `isAutoColumnWidths` - CSS grid auto column sizing
- React `isAutoFit` - auto-fit grid columns for responsive
- React `isCompact` - reduced spacing
- React `isFluid` - term width grows with content
- React `isFillColumns` - fill CSS grid columns vertically
- React `columnModifier`: `1Col`, `2Col`, `3Col` (+ responsive breakpoint variants) - CSS grid columns
- `DescriptionListTermHelpText` - term with help icon and tooltip; consider slot pattern
- `pf-v6-description-list-group` renders ``, `pf-v6-description-list-term` renders `
- `, `pf-v6-description-list-description` renders `
- ` - or slot-based
- API per `.claude/ADVICE.md`
- CSS uses v6 tokens, logical properties, nesting
- `@summary` and JSDoc on element class
- Renders semantic `
- `/`
- `/`
- ` structure
- Demos match patternfly.org naming/structure
- CSS custom properties match computed styles from patternfly.org (Chrome MCP)
- Visual parity verified via Chrome MCP
- Public API covered (attributes, properties, events, slots)
- `a11ySnapshot` assertions
- `/review-api` passes
- `/review-demos` passes
- `/review-a11y` passes
- `eslint` and `stylelint` pass
- Add changeset
- PR targets `staging/pfv6` (NOT `main`)
Prior Art
| Source | Element | Status |
|---|---|---|
| PFE v4 | -- | -- |
| cem | -- | -- |
| cockpit | -- | -- |
| chickadee | -- | -- |
Requirements
Proposed API
<pf-v6-description-list>
<pf-v6-description-list-group term="Term">
Description
</pf-v6-description-list-group>
<pf-v6-description-list-group>
<span slot="term">Term 2</span>
Description
</pf-v6-description-list-group>
</pf-v6-description-list>Element-specific considerations
Checklist
Implementation
Demos
Tests
Reviews
Ship
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
1:1Aligning components with PatternFly v4Aligning components with PatternFly v4good 1st issueGood for newcomers to the project; requires at least an introductory knowledge of the languageGood for newcomers to the project; requires at least an introductory knowledge of the languagepriority: lowSeverity level: 3Severity level: 3
Activity
[-][feat]: Create `<pf-description-list>`[/-][+][feat]: Create `<pf-description-list>` element[/+]chubara62372 commentedon Oct 22, 2025
@zeroedin
There is an example to see what should come out at the end.
bennypowers commentedon Oct 22, 2025
https://v4-archive.patternfly.org/v4/components/description-list/
chubara62372 commentedon Oct 22, 2025
@bennypowers
Do I need to do all the options in the example?
bennypowers commentedon Nov 5, 2025
pf-description-list needs to look and feel like its react counterpart, and the public APIs need to be as similar as possible, with changes acceptable when react's APIs are react-specific (i.e. slots, attributes, and/or events in place of render props)
[-][feat]: Create `<pf-description-list>` element[/-][+][feat]: Create `<pf-v6-description-list>` element[/+]