microsoft / microsoft/fluentui-react-native

Components: Generate Field

Open
#4,225 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.4k
Forks
179
Avg merge
16h 17m
Merged PRs (30d)
30

Description

Summary

Generate Field with its canonical contract, implementation, tests, stories, platform validation, and explicit package export so form controls can share labeling, helper text, and validation behavior. The local spec must be ingested first, and the final composition depends on the Label association decision and shared status-icon source.

Observed. field is entry field in the canonical catalog and has no
implementation in packages/agentic/components. Upstream describes it as: Composed form-field wrapper pairing a Label or InfoLabel with a content slot for a form control, plus optional helper text and a validation message. Covers Orientation, three sizes, a Status axis (Rest, Error, Warning, Success, Disabled), and a Weight option forwarded to Label.

Goal

Generate the field 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 3 (production). Wave 3 - focus-orchestrated and composed.

Why it matters

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

Inferred. It is a composed or focus-orchestrated component whose blockers resolve once the wave 2 overlay stack and the focus decision land, so it is a direct measure of whether those foundations were built correctly.

Observed current state

Canonical spec and source
Field Value
Canonical spec plugins/components/skills/field/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 field in component-map.yaml
Local staged spec None. No specs/field folder exists; the spec must be ingested first
Local implementation None. No src/components/field directory exists
Closest existing FURN or V1 implementation
  • No field wrapper exists in any FURN catalog. The nearest reference is packages/components/Input, whose desktop path is Input.tsx with InputTokens.ts; its .ios, .android, and .mobile variants are mobile-only.

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:
    field.types.ts, field.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.
  • Depends on label, including the control-association contract decided there, and optionally on info-label.
  • Decide how Status propagates to the wrapped control: a context, cloned props, or a caller responsibility.
  • Consume the cross-platform status icon source owned by
    message-bar for the validation message.

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/field/ implementing the full required file structure.
  • SPEC.md and a spec/ companion folder with provenance recording the upstream path,
    SHA, and ingestion date.
  • Colocated field.test.tsx, field.types.test.ts, and field.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:

  • Both orientations across all three sizes.
  • Every Status value, including the validation message and its icon.
  • Helper text present and absent.
  • Label and InfoLabel in the label slot.
  • The wrapped control receives the association and the disabled state through the accessibility tree.
  • Weight forwarding to Label.
  • 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/Field, 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/field 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.
  • Blocked by wave 2, either directly or through a wave 2 dependency listed above.
  • 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. The propagation mechanism is the main design decision and affects every control that can be wrapped; a context is the least intrusive but adds a cross-component coupling the package currently avoids.
  2. It transitively depends on the label association decision, which is itself a spec-retargeting question.

Evidence and references

Sources retrieved 2026-08-20.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the upstream field spec files and the local spec-ingestion guidance, then review src/components/AGENTS.md and the existing input, checkbox, radio, and switch components. Confirm the Label and status-icon dependencies before defining the contract; done means the required field files, SPEC.md/spec provenance, tests, stories, exports, platform validation, changeset, and readiness evidence are complete and the listed workspace and Storybook checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
react-native, storybook, typescript
Domain
desktop, frontend, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.