Skip to content

Components: Generate NavItem #4234

Description

@JasonVMo

Summary

Generate NavItem with its canonical contract, implementation, tests, stories, platform validation, and explicit package export so navigation containers have a consistent row primitive. Its generated dependencies are available; ingesting the missing local spec is the first and only shared prerequisite.

Observed. nav-item is entry nav-item in the canonical catalog and has no
implementation in packages/agentic/components. Upstream describes it as: Selectable navigation row inside a Nav. Owns leading icon or Avatar, primary label, optional trailing badge or count slot, optional trailing secondary actions, a nested indented sub-item variant, Density, and the current-destination Selected model (soft fill, brand start-edge indicator bar, strong label, Regular to Filled brand icon). Defers list orchestration and focus to the parent Nav.

Goal

Generate the nav-item component in
packages/agentic/components/src/components against the
canonical Fluent Flex spec, with the colocated coverage, stories, and platform
validation the package requires, and export it explicitly from
src/index.ts.

Stage

Stage 2 (beta). Wave 1 - local component dependencies already generated.

Why it matters

Observed. The canonical catalog has 50 components and the agentic library has
generated 18. nav-item is one of the 32 in the gap, enumerated in
the missing-components index.

Inferred. Every local dependency this component needs is already generated, so it is deliverable without new shared infrastructure and contributes directly to the beta catalog.

Observed current state

Canonical spec and source

Field Value
Canonical spec plugins/components/skills/nav-item/SKILL.md with usage.md, web/tokens.yaml, web/accessibility.md, and web/interaction.md, at x3-design/fluent-design @ d334acf
Upstream tier molecule
Upstream catalog key nav-item in component-map.yaml
Local staged spec None. No specs/nav-item folder exists; the spec must be ingested first
Local implementation None. No src/components/nav-item directory exists

Closest existing FURN or V1 implementation

  • No navigation row exists in any FURN catalog. The closest local structural analogue is src/components/list-item, which already uses the shared compound-item-layout primitive for leading content, primary and secondary text, and trailing slots.

Note on platform canon. Where a legacy package has platform-specific files, the
desktop path (.win32, .windows, .macos, or the unsuffixed cross-platform file)
is the compatibility reference. .ios, .android, and .mobile variants are not
treated as the cross-platform canonical implementation.

Local dependencies

Known blockers

Observed. There is no recorded blocker, because there is no local spec folder and therefore no
blockers.md. The absence of an ingested spec is itself the first blocker; see
spec-ingestion-and-generation.md.

Scope

  • Ingest or promote the spec into the component directory in the generated shape
    (SPEC.md plus a spec/ folder), per
    spec-ingestion-and-generation.md.
  • Establish the public contract first: variants, slots, native props, accessibility,
    interaction states, and platform behavior.
  • Implement the required file structure from
    src/components/AGENTS.md:
    nav-item.types.ts, nav-item.styles.ts, use*.ts, use*Styles.ts, render*.tsx, and
    the assembly module with a displayName.
  • Style from Flex tokens first and record genuine token gaps rather than substituting
    unrelated values.
  • Export the component, its public types, and the state, style, and render stages
    explicitly from src/index.ts under component-qualified unstable names.
  • Reuse the compound-item-layout primitive rather than re-implementing row anatomy; the upstream anatomy matches what list-item, listbox-item, and menu-item already share.
  • Keep Selected externally driven: the parent Nav owns the current destination and the item reports presses.
  • Implement the Regular to Filled icon swap and the start-edge indicator bar as part of the Selected contract.

Out of scope

  • Changing the contract of an existing generated component, unless this task explicitly
    calls for it above; raise it as its own item.
  • Building shared infrastructure owned by another task: overlay hosting
    (popover), roving focus (focus-zone.md), spec
    ingestion (spec-ingestion-and-generation.md),
    or the coverage contract (component-test-strategy.md).
  • Migrating any legacy FURN consumer onto this component.
  • Mobile platform support; the applicable upstream companion is web, retargeted to
    React Native for Windows and macOS.

Deliverables

  • src/components/nav-item/ implementing the full required file structure.
  • SPEC.md and a spec/ companion folder with provenance recording the upstream path,
    SHA, and ingestion date.
  • Colocated nav-item.test.tsx, nav-item.types.test.ts, and nav-item.stories.tsx.
  • Snapshot coverage where the visual contract is state-dependent, or a recorded
    exemption.
  • Explicit exports from src/index.ts, with src/index.test.ts updated.
  • A changeset, per the repository's version management rules.
  • A recorded readiness level with its supporting evidence.

Required coverage, stories, and platform validation

Runtime and type coverage:

  • Every Density value.
  • Leading icon and leading Avatar, mutually exclusive.
  • Trailing badge or count present and absent; trailing secondary actions present and absent.
  • Nested sub-item variant indentation.
  • Selected and unselected, including the icon swap, and that pressing a selected item does not change selected locally.
  • Accessible name, role, and selected state.
  • User style and handler forwarding, and that user styles are applied after component
    styles.
  • Compile-time slot acceptance and any mutually exclusive props.

Stories: a typed Meta titled Components/NavItem, an args-driven Default, a
grouped Overview when the contract has several axes, one focused story per variant
axis, and an interactive story for each stateful axis. Self-driving axes expose
default<State> as the control; externally driven selection is owned by the story with
React.useState. Identity-changing axes are not exposed as controls.

Platform validation: the component's stories render and behave correctly on macOS
and on React Native Windows Fabric through apps/storybook,
including hover, pressed, disabled, focus, optional-slot, and constrained-content
scenarios. Add a stable root testID if the component joins the automated smoke set.

Acceptance criteria

  • src/components/nav-item exists with the required file structure and a displayName.
  • Every variant axis in the component's SPEC.md is implemented, or a deviation is recorded in the spec.
  • The component styles from Flex tokens, with any genuine token gap recorded rather than approximated.
  • Focus feedback renders through FocusVisual; no outline* props and no React Native Windows native focus visuals are introduced.
  • State precedence is explicit: disabled wins over pressed, which wins over hovered.
  • Every stateful axis is classified as self-driving or externally driven, and both paths are covered.
  • Runtime, type, and story coverage satisfy the package coverage contract.
  • The component, its public types, and its pipeline stages are exported explicitly from src/index.ts, and src/index.test.ts covers them.
  • The component's stories render on macOS and on React Native Windows Fabric.
  • yarn workspace @fluentui-react-native/components format, lint, build, and test pass, and the Storybook bundle succeeds for both desktop platforms.
  • A readiness level is recorded with its supporting evidence.
  • A changeset is included.

Dependencies and ordering

  • Blocked by spec-ingestion-and-generation.md: the spec must be pulled from the pinned upstream revision before generation can start.
  • Gated by component-test-strategy.md: the component must satisfy the coverage contract on arrival rather than being retrofitted.
  • Gated by readiness-model.md: the target readiness level must be stated before the work starts.
  • Consumes the Infrastructure workstream (storybook-e2e.md) for automated macOS and Windows Fabric validation; until it lands, platform validation is manual.

Risks and open decisions

  1. It blocks both nav and simple-nav, so its slot contract should be settled with both consumers in mind.
  2. The start-edge indicator bar interacts with the FocusVisual ring geometry; both must be verified together on Windows Fabric.

Evidence and references

Sources retrieved 2026-08-20.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions