[feat]: Create `<pf-v6-nav>` element

未关闭
#3,024 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
32/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清
技术栈
css, typescript

调研方向

Start with .claude/ADVICE.md and the linked PatternFly Navigation design, then compare the React Nav API and the listed sub-components. Done means the element, demos, public API tests, accessibility snapshots, reviews, lint checks, changeset, and staging/pfv6 targeting satisfy the checklist.

由索引模型根据 Issue 内容生成。

描述

1:1 for dev priority: medium

Summary

Create `` to implement the PatternFly v6 Navigation component.

Application sidebar or horizontal navigation with support for grouped items, expandable sections, and flyout menus.

Prior Art

Source Element Status
PFE v4 -- --
cem `` Exists
cockpit `` Exists
chickadee `` Exists

Sub-components

  • `` - Individual navigation link
  • `` - Grouped navigation items with title
  • `` - Expandable section within navigation

Requirements

  • MUST implement PFv6 visual designs
  • MUST provide end-user feature parity with `@patternfly/react-core` Nav
  • MAY adjust element API to leverage web platform strengths
  • SHOULD maintain CSS custom property theming compatibility
  • SHOULD expose useful CSS shadow parts

Element-specific considerations

  • React `variant`: `default`, `horizontal`, `tertiary`, `horizontal-subnav` - map to `variant` attribute
  • React `isScrollable` - vertical nav with scroll; map to `scrollable` attribute
  • React `aria-label` - required for `` landmark (e.g. "Global navigation")
  • `NavItem`: `to` (href), `isActive`, `component`, `icon`, `flyoutMenu` (for flyout menus)
  • `NavGroup`: `title`, `id`, `aria-label`
  • `NavExpandable`: toggle for sub-nav; isExpanded, defaultExpanded, onExpand; contains `NavList`
  • Flyout menus: `NavItem flyoutMenu` - opens a `` on hover/arrow key; needs Floating UI
  • Active item: `aria-current="page"` on the active `NavItem` link
  • Wraps in `` element for landmark

Checklist

Implementation
  • API per `.claude/ADVICE.md`
  • CSS uses v6 tokens, logical properties, nesting
  • `@summary` and JSDoc on element class
  • Renders `` element with `aria-label`
Demos
  • Demos match patternfly.org naming/structure
  • CSS custom properties match computed styles from patternfly.org (Chrome MCP)
  • Visual parity verified via Chrome MCP
Tests
  • Public API covered (attributes, properties, events, slots)
  • `a11ySnapshot` assertions
Reviews
  • `/review-api` passes
  • `/review-demos` passes
  • `/review-a11y` passes
  • `eslint` and `stylelint` pass
Ship
  • Add changeset
  • PR targets `staging/pfv6` (NOT `main`)
主要语言
TypeScript
星标
394
派生
107
PR 合并指标
30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

patternfly/patternfly-elements 的其他 Issue

查看 patternfly/patternfly-elements 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。