Forms
Field Error Summary
The WCAG error-summary pattern for long forms: an assertive live region listing every invalid field as a jump-to link, self-focusing on mount after a failed submit.
$ velocityx add field-error-summary
Built for react.
Needs react already installed
as a peer dependency.
An Astro-only project needs @astrojs/react wired up first — this won't run on its own in plain Astro.
Full docs for Field Error Summary →
Needs a licence key — buy lifetime access here, then
velocityx login once.
- Framework
- react
- Source
- 103 lines
- FieldErrorSummary.jsx
- Runtime
- Interactive
- runs in the browser
- Theme
- 2 tokens
- re-themes from your scale
- Dark mode
- Built in
- dark: variants
- Accessibility
- 3 ARIA
- attributes and roles
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| errors | { fieldId: string, message: string }[] | No | [] | |
| heading | string | No | 'Please fix the following' | |
| className | string | No | '' |
Using it
The smallest call that compiles — required props only. The import is
written for your own file at src/components/Example.jsx;
adjust the relative import if yours sits elsewhere.
Everything optional is in the table above, with its default.
import FieldErrorSummary from './velocity/field-error-summary/FieldErrorSummary';
export default function Example() {
return (
<FieldErrorSummary />
);
}Built from Field Error Summary's own prop signature and the path the CLI installs it to, so it can't drift from either.
Accessibility
- ARIA roles
- alert
- ARIA attributes
- aria-hidden, aria-live
- Keyboard
- Built on native controls — Enter/Space work as standard
- Focus
- Moves or traps focus deliberately
- Announcements
- Uses an aria-live region
Read from the source, not asserted — anything not listed simply isn't in this component's markup.
Behaviour
- Ships client JS
- Yes — this one needs to hydrate
- React hooks
- useEffect, useRef
- Dark mode
- Carries its own dark: variants
Theming
This component paints from 2 steps of
your theme scale — no hardcoded colours, and no font-family of
its own, so your type cascade wins. Override the variables and it follows.
primary-600primary-700Get the Velocity preset and CSS theme from the public source guide. The CLI theme command is not available on npm yet.
File this creates
The CLI writes this path into your project — nothing
else moves. Paths are under your source root, which defaults to
src/; pass
--dest if yours is elsewhere.
-
src/components/velocity/field-error-summary/FieldErrorSummary.jsx103 lines
Copy the paths
src/components/velocity/field-error-summary/FieldErrorSummary.jsxField Error Summary — questions
How do I install Field Error Summary?
Run velocityx add field-error-summary . The CLI writes the source straight into your project — it is not a runtime package dependency.
Do I need a licence for Field Error Summary?
Yes. It is part of the lifetime library — buy access at https://aidxn.com/shop/velocity-x-component-library/, authenticate once, and install it. Your lifetime licence includes future component updates.
Can I edit Field Error Summary after installing it?
Yes — the files are yours once written. The CLI compares its lockfile hash before upgrades and refuses to overwrite code you changed.
Does Field Error Summary ship JavaScript to my users?
Yes. It runs in the browser (useEffect, useRef), so it needs to hydrate — in Astro, give it a client:* directive.
Will Field Error Summary match my brand colours?
Yes. It paints entirely from your theme scale — 2 steps of primary-* / accent-* — with no hardcoded hex values and no font-family of its own. Override the theme CSS variables and it follows your design system instead of ours.
Is Field Error Summary accessible?
It ships ARIA roles (alert), 2 ARIA attributes, native controls that are keyboard-operable by default, deliberate focus management. That is read directly from the source rather than claimed — you should still test it in the context you drop it into.
Does Field Error Summary pull in any dependencies?
No external ones. Every component in the library is built with react/react-dom or plain Astro only — no GSAP, Radix, Swiper or Headless UI — which is what makes dropping it into an existing project safe.
Set up & reference
All docs →Install this component:
$ velocityx add field-error-summary- 2. Install the theme — run this first, once per project Do this once per project, before your first component.
- The palette gotcha — this one bites silently Silent failure — the component renders, just unstyled.
- Your edits are safe by default What happens to your changes when you upgrade.
- You own the code What you are actually buying.
Related components
More from Forms.
Debounced address-search UI shell with keyboard-navigable suggestions dropdown; geocoding is supplied by the host via props.
reactStyled native date and time input pair with a combined human-readable preview and a clear action.
reactA Continue with Email button that morphs in place into an email field on click — the progressive-disclosure auth pattern, reduced-motion safe.
reactDrag-and-drop file picker with browse fallback, size validation, and a removable selected-files list.
react