Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 114 additions & 0 deletions plugins/pf-react/agents/component-structure-audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This agent has a "How to Run" workflow and produces a report — that reads more like a skill (task that produces a result) than an agent (domain knowledge the AI always follows). Meanwhile the SKILL.md reads more like reference knowledge. Are these two swapped?

name: component-structure-audit
description: PatternFly React structural composition rules — required hierarchies, wrapper components, and props-vs-children patterns. Use when writing, reviewing, or refactoring PatternFly UI so layouts rely on correct trees, not custom CSS.
---

# PatternFly component structure

Enforce correct **parent-child composition**: PatternFly’s layout CSS targets named wrappers — use them; avoid raw divs or bare controls where a component expects **`ToolbarContent`**, **`NavList`**, **`CardBody`**, etc. For **repo scans and violation reports**, use `skills/patternfly-component-structure/SKILL.md`.

## Page and shell

- **`Page`**: Put main content in **`PageSection`** (or **`PageGroup`** with sections inside). Do not use arbitrary divs as direct children for primary content.
- **`masthead`** and **`sidebar`** are **`Page` props**, not children.
- **`PageSection`** auto-wraps children in **`PageBody`** for horizontal padding. Use **`hasBodyWrapper={false}`** only when you need multiple **`PageBody`** regions.
- **`PageSidebar`** must wrap its content in **`PageSidebarBody`**.

## Masthead

```
Masthead
├── MastheadMain
│ ├── MastheadToggle → PageToggleButton
│ └── MastheadBrand → MastheadLogo
└── MastheadContent
```

**MastheadMain** groups toggle and brand for flex layout. **MastheadLogo** uses **`component="a"`** when it should be a link.

## Toolbar

```
Toolbar
└── ToolbarContent ← required
└── ToolbarGroup / ToolbarItem / ToolbarToggleGroup …
```

**ToolbarContent** is never optional. Each control should sit in a **`ToolbarItem`** (directly or inside **`ToolbarGroup`**).

## Card

```
Card
├── CardHeader → CardTitle (optional)
├── CardBody ← provides padding; don’t skip for main content
├── CardFooter
└── CardExpandableContent (expandable cards)
```

Expandable content belongs in **`CardExpandableContent`**, not only in **`CardBody`**.

## Modal

```
Modal
├── ModalHeader
├── ModalBody
└── ModalFooter
```

Set **`aria-labelledby`** to match **`ModalHeader`**’s label id, or **`aria-label`**. **`onClose`** is required for the close affordance.

## Drawer

- **`DrawerPanelContent`** is passed as **`panelContent`** on **`DrawerContent`**, not as a sibling child inside **`DrawerContent`**.
- Main column content goes in **`DrawerContentBody`**.
- **`DrawerCloseButton`** belongs under **`DrawerActions`** inside **`DrawerHead`**.

## Navigation

```
Nav
└── NavList ← required
├── NavItem
├── NavExpandable → NavItem
└── NavGroup → NavItem ← NavGroup owns an internal NavList; don’t wrap its children in another NavList
```

## Table (`@patternfly/react-table`)

```
Table
├── Caption (optional, first)
├── Thead → Tr → Th
└── Tbody → Tr → Td
```

Never put **`Tr`** directly under **`Table`**. Use **`dataLabel`** on **`Td`** for responsive/stacked layouts. Expandable row content uses **`ExpandableRowContent`** inside **`Td`** with appropriate **`colSpan`**.

## DataList

- **`DataList`** needs **`aria-label`**; **`DataListItem`** needs **`aria-labelledby`**.
- **`DataListItemRow`** is required; cells go through **`DataListItemCells`** / **`dataListCells`**, not ad hoc structure.
- **`DataListContent`** is a **sibling** of **`DataListItemRow`**, not nested inside the row.

## Tabs

- Panel content is **`Tab`**’s **children**; the visible tab label is the **`title`** prop (often **`TabTitleText`** / **`TabTitleIcon`**), not raw text children.
- Each **`Tab`** needs a unique **`eventKey`**.

## EmptyState

**`EmptyStateIcon`** lives under **`EmptyStateHeader`**, not directly under **`EmptyState`**. Do not mix shortcut props (`titleText`, `icon`) with an explicit **`EmptyStateHeader`** tree — pick one approach.

## DescriptionList

**`DescriptionListGroup`** is required between **`DescriptionList`** and **`DescriptionListTerm`** / **`DescriptionListDescription`**.

## Sidebar

**`Sidebar`** composes **`SidebarPanel`** and **`SidebarContent`**. Panel width uses breakpoint objects (see **`references/containers.md`**).

## Deeper reference

Props tables, anti-patterns, and full examples: `skills/patternfly-component-structure/references/` (`page-layout.md`, `containers.md`, `data-components.md`, `navigation-toolbar.md`).
97 changes: 97 additions & 0 deletions plugins/pf-react/skills/patternfly-component-structure/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

At 331 lines this is well over the 200-line guideline. You already have 4 reference files — could more of the component hierarchy details be moved there to keep the core instructions shorter?

description: Guide for PatternFly React component structure — audits, correct nesting, and layout debugging. Use when building with @patternfly/react-core or @patternfly/react-table, scanning code for hierarchy violations, or fixing spacing and alignment issues.
---

Use this skill when you need a **structural audit** of PatternFly usage, or when fixing layouts caused by skipped wrappers. For day-to-day composition rules while writing UI, use the **component-structure-audit** agent (pf-react) or your client’s equivalent subagent for PatternFly structure.

## PatternFly MCP

If `@patternfly/patternfly-mcp` is available, use it for current props, examples, and new components. This skill and the reference files define **nesting and wrapper rules**; the MCP fills in API details.

## Why structure matters

Layout CSS targets specific parent-child trees. Skipping wrappers (`ToolbarContent`, `CardBody`, `PageSection`, etc.) breaks spacing and alignment; custom CSS is usually papering over a wrong tree. **Use every structural wrapper PatternFly provides for that region.**

## Where the hierarchies live

Reference files hold trees, props notes, examples, and anti-patterns — not duplicated here:

| Area | File |
|------|------|
| Page, PageSection, PageGroup, PageSidebar, Masthead | `references/page-layout.md` |
| Card, Modal, Drawer, EmptyState, Sidebar | `references/containers.md` |
| Table, DataList, DescriptionList | `references/data-components.md` |
| Nav, Tabs, Toolbar | `references/navigation-toolbar.md` |

Read the relevant file before suggesting structure for that family.

## Auditing component structure

### How to run

1. Ask the user which directory or files to audit. Default to the current working directory.
2. Search for files importing from `@patternfly/react-core` or `@patternfly/react-table`.
3. For each file, check for the violations below.
4. Report findings grouped by file, with line numbers and the specific violation.
5. If the user requests fixes, apply them. Only fix unambiguous structural issues — if a fix would change behavior or needs a design decision, report it and ask.

### Violations to detect

Use the same structural rules as the **component-structure-audit** agent; during a scan, flag the issues below. **Anti-pattern examples** live in the reference files for each family.

| Area | Flag |
|------|------|
| Page layout | Direct `<Page>` children that aren’t `<PageSection>` / `<PageGroup>`; `<PageSidebar>` without `<PageSidebarBody>`; `<PageSection hasBodyWrapper={false}>` without `<PageBody>` (info) |
| Masthead | `<MastheadBrand>` / `<MastheadToggle>` not under `<MastheadMain>`; `<MastheadLogo>` outside `<MastheadBrand>` |
| Toolbar | `<Toolbar>` children aren’t `<ToolbarContent>`; controls in `<ToolbarContent>` / `<ToolbarGroup>` without `<ToolbarItem>` |
| Card | Raw content in `<Card>` outside `<CardBody>` / `<CardHeader>` / `<CardFooter>`; expandable card missing `<CardExpandableContent>` |
| Modal | Missing `<ModalHeader>` / `<ModalBody>` / `<ModalFooter>`; missing `aria-labelledby` or `aria-label` |
| Drawer | `<DrawerPanelContent>` as child of `<DrawerContent>` instead of `panelContent`; `<DrawerContent>` without `<DrawerContentBody>`; `<DrawerCloseButton>` not under `<DrawerActions>` in `<DrawerHead>` |
| Navigation | `<NavItem>` not under `<NavList>`; extra `<NavList>` inside `<NavGroup>` |
| Table | `<Tr>` direct under `<Table>`; `<Th>` in body rows or `<Td>` in header rows; `<Td>` without `dataLabel` (**WARN**) |
| DataList | Missing `aria-label` on `<DataList>`; item without `<DataListItemRow>`; row without `<DataListItemCells>`; `<DataListContent>` inside `<DataListItemRow>` (should be sibling) |
| Tabs | Tab label as children instead of `title`; `<Tab>` without `eventKey` |
| EmptyState | `<EmptyStateIcon>` directly under `<EmptyState>`; mixing `titleText`/`icon` with explicit `<EmptyStateHeader>` |
| DescriptionList | Terms/descriptions directly under `<DescriptionList>` without `<DescriptionListGroup>` |

### Report format

For each violation:

```
[ERROR|WARN] file/path.tsx:42 - <Toolbar> has direct children that are not <ToolbarContent>
Found: <Button> as direct child of <Toolbar>
Fix: Wrap children in <ToolbarContent><ToolbarItem>...</ToolbarItem></ToolbarContent>
```

Use `ERROR` for layout-breaking issues; `WARN` for best-practice gaps. End with a summary:

```
Scanned: 23 files
Errors: 7 (across 4 files)
Warnings: 3 (across 2 files)
```

Group by violation type so patterns are visible.

### Applying fixes

1. Only fix structure when the correct hierarchy is unambiguous.
2. Preserve props, handlers, and content.
3. Do not reformat unrelated code.
4. Summarize what changed.

**Usually safe:** Wrapping in missing intermediates (`ToolbarContent`, `ToolbarItem`, `CardBody`, `NavList`, `DescriptionListGroup`, …); moving `DrawerPanelContent` to `panelContent`; adding `<Thead>` / `<Tbody>`.

**Needs user input:** New `aria-label` / `aria-labelledby` text; choosing `titleText` vs `<EmptyStateHeader>`; unclear nested intent.

### Custom CSS

**During an audit:** If spacing or padding overrides sit next to a structural issue, add an info line, e.g.:

```
[INFO] file/path.tsx:42 - Custom CSS spacing override near structural violation
.my-toolbar-fix { padding: 8px } may compensate for missing <ToolbarContent>
```

**Before suggesting new overrides:** Map the symptom to a missing wrapper when possible — page content → `PageSection` / `PageBody`; toolbar → `ToolbarContent` / `ToolbarItem`; card → `CardBody`; nav → `NavList`; description list → `DescriptionListGroup`; drawer panel → `panelContent` prop (see reference files for full trees).
Loading