Form Group

Structural legend/description/error grouping for related controls without becoming one accessible parent element.

Distribution status

BeeUI 0.86.2-rc.3 is public on npm under the opt-in next dist-tag (observed 2026-09-25T06:25:18.371Z). latest currently resolves to 0.86.2-rc.3 and lags next until the owner moves it for all four packages. See Start for the full install commands. The import shape below works against the published package; the repository-local Registry command remains available as a no-registry-required alternative from a BeeUI checkout. Pin @0.86.2-rc.3 instead of @next for an immutable version in CI.

Identity

• Category: Forms & selection
• Status: stable public Registry/export-map component family
• Targets: iOS · Android · Web, subject to the compatibility contract
• Prerequisites: @beemvp/beeui-ui installed (or this component’s source copied via the Registry CLI below) and, on Web, the BeeUI Tailwind/Uniwind theme CSS loaded — see Start for full platform setup.
• Source: packages/ui/src/components/form-group.tsx

Import

import { FormGroup } from '@beemvp/beeui-ui';

There is no documented deep/private source import. For source ownership from a BeeUI checkout:

pnpm beeui add form-group

Registry (used throughout this page) is BeeUI’s source-ownership manifest — registry/registry.json — that the pnpm beeui/@beemvp/beeui-cli CLI reads to copy a component’s real source into your app and rewrite its internal imports; it is not an npm package index. This component’s own Registry entry: registry/registry.json.

Composition and public API

• Primary export: FormGroup
  • Also routed here, outside the Registry family:
    • form-group
  • Package export subpath: @beemvp/beeui-ui/form-group

Exported types: FormGroupProps

The generated API inventory is mechanically joined to packages/ui/src/index.ts, Registry metadata, and the component reference contract. Each type’s field table below is parsed directly from that source, not a second hand-maintained copy; for the fuller behavior narrative see the canonical component behavior catalog.

State and behavior contract

Structural legend/description/error/disabled grouping; it stays accessible={false} (there is no generic native fieldset role) and never mutates descendant state directly — only semantic-aware children such as RadioGroup opt into consuming its context.

Props

FormGroupProps

Prop	Type	Default	Description
children (required)	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
className	string	—	Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee.
description	string	—	Secondary supporting text rendered beneath the primary label or title.
disabled	boolean	false	ORed into a RadioGroup rendered as children, disabling every Radio inside it. Defaults to false.
error	string	—	Shown instead of description, styled destructively, when invalid is true.
invalid	boolean	false	Switches the helper text below children from description to error. Defaults to false.
legend (required)	string	—	Heading text for the group, rendered as a Label above children (e.g. “Shipping method”).
legendNativeID	string	—	nativeID for the rendered legend Label, used to build accessibilityLabelledBy links (e.g. from a RadioGroup rendered as children). Defaults to a generated, stable-per-mount ID.
required	boolean	false	Renders the legend with a required indicator and, when requiredAccessibilityLabel is also supplied, appends it to the accessible name. Defaults to false.
requiredAccessibilityLabel	string	'required'	Text appended to the legend’s accessible name when required is true (e.g. “Shipping method, required”). No default — omit to expose required only through the group’s own required semantics on its interactive descendants, without injecting English copy.

Also carries every prop of Omit<ViewProps, 'accessibilityRole' | 'accessible' | 'children' | 'role'> — that upstream contract is not reproduced here.

The executable fixtures below are the source-grounded usage examples; consumers should not infer state ownership from DOM structure or another UI library.

Provider and dependencies

• No additional provider is required by this family. BeeUIProvider remains the recommended application root.
• Peer/native dependencies visible to this Registry item: react, react-native
• Registry dependency closure: core-cn, form-group-context, label, text, theme
• Safe-area ownership remains explicit: shell surfaces touching system edges opt into SafeArea; components do not silently invent app-shell insets.
• Web consumers load the BeeUI semantic theme CSS as documented in Web onboarding.

Platform behavior

This family ships no platform-specific file, but its source branches on Platform, so some behavior differs by target.

The same public family is exposed across the supported target matrix; meaningful platform differences remain governed by the compatibility contract.

Evidence classes are not equal and this page does not blur them: Web behavior is exercised in a real browser, while iOS and Android carry package/export and native-compile evidence, which is not device-runtime proof. The compatibility contract records which class each claim rests on.

Accessibility

• Roles this family assigns: alert, group — set in form-group.tsx by the components themselves, not by the caller.
• Accessibility states and properties it sets: accessibilityLabel, accessibilityLabelledBy, accessibilityLiveRegion, describedby (Web), disabled, invalid (Web), labelledby (Web) — read from form-group.tsx.

Keyboard/focus behavior, announcements, Dynamic Type/Web zoom, RTL and reduced-motion expectations are not derived here — see Accessibility overview, Keyboard & focus, RTL/localization and Large text & zoom. BeeUI does not claim universal accessibility certification from automated tests.

Styling and theming

• Style axes: none of its own — its appearance comes from tokens and your own classes; it also carries Omit<ViewProps, 'accessibilityRole' | 'accessible' | 'children' | 'role'>.
• Class-name surfaces: className.

Colors, spacing and typography come from semantic tokens rather than from values written here — see Theming and Density. A className is an escape hatch for source-owned and application work, not a cross-engine portability guarantee.

Executable examples

• Primary executable fixture: apps/showcase/__tests__/checkbox-radio-field-form-group-context.test.tsx
• Additional fixture: apps/showcase/__tests__/field-label-accessible-name-dedup.test.tsx
• Additional fixture: apps/showcase/__tests__/form-group-checkbox-list-group-semantics.test.tsx
• Additional fixture: apps/showcase/__tests__/issue-15-alert-dialog-form-group.test.tsx

Addressable examples

Each link below opens the Showcase at that exact example, not at the top of the gallery:

• basic — smallest meaningful complete usage

The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.

Live Web preview

This frame loads the real BeeUI Web Showcase on demand; it is not a second docs-only implementation. It proves browser behavior only. Use native preview for iOS/Android simulator, emulator or device paths.

Composition anatomy

• Family root / primary export: FormGroup
  • Exported type surface:
    • FormGroupProps

The tree above is ordinary document structure so it remains readable with keyboard and assistive technology; it is derived from the real public export family rather than a canvas-only diagram.

Verified example source

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Form Group is actually used: 34 lines in 1 place. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. The rest of that file exercises other families and is not reproduced here.

Imports the examples below need (a filtered subset of the fixture’s own top-level imports):

import { Checkbox, FormGroup, Radio, RadioGroup } from '@beemvp/beeui-ui';
import * as React from 'react';

Fixture state this block reads (same file, lines 460, 462):

  const [assignedStores, setAssignedStores] = React.useState<string[]>([]);
  const [plan, setPlan] = React.useState<'starter' | 'pro'>('starter');

lines 631–664:

              <FormGroup
                description="The group owns legend/guidance metadata while each radio stays independently discoverable."
                legend="Subscription plan"
                required
              >
                <RadioGroup
                  onValueChange={(value) => setPlan(value as 'starter' | 'pro')}
                  value={plan}
                >
                  <Radio label="Starter plan" value="starter" />
                  <Radio label="Pro plan" value="pro" />
                </RadioGroup>
              </FormGroup>
              <FormGroup
                error="Select at least one store."
                invalid={assignedStores.length === 0}
                legend="Assign to stores"
                required
                testID="stores-form-group"
              >
                {['Store A', 'Store B', 'Store C'].map((store) => (
                  <Checkbox
                    checked={assignedStores.includes(store)}
                    key={store}
                    label={store}
                    onCheckedChange={(checked) =>
                      setAssignedStores((current) =>
                        checked ? [...current, store] : current.filter((value) => value !== store),
                      )
                    }
                    testID={`stores-checkbox-${store.replace(/\s+/g, '-').toLowerCase()}`}
                  />
                ))}
              </FormGroup>

Open the fixture itself for the full surrounding component. For a smaller app-specific example, start from the imports and fixture-state blocks above and keep only the state your screen owns.

Limitations

RadioGroup is the only component in the package that reads this group’s context, so its disabled, invalid and legend link reach a radio group and nothing else: a checkbox, switch or input nested in a form group is unaffected and has to be wired by hand. The group is deliberately not one accessible element and accepts no role override.

Related

• All components
• Production patterns
• Showcase
• CLI & source ownership
• Source