Forms
Phone Number Field
A combined country-dial-code select and national-number input with digit-only sanitisation, emitting one combined E.164-shaped value.
$ velocityx add phone-number-field
Needs a licence key — buy lifetime access here, then
velocityx login once.
$ velocityx add phone-number-field@1.0.0
Needs a licence key — buy lifetime access here, then
velocityx login once.
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 Phone Number Field →
- Framework
- react
- Source
- 146 lines
- PhoneNumberField.jsx
- Runtime
- Interactive
- runs in the browser
- Theme
- 7 tokens
- re-themes from your scale
- Responsive
- sm
- 1 breakpoint
- Dark mode
- Built in
- dark: variants
- Accessibility
- 3 ARIA
- attributes and roles
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | No | 'phone' | |
| label | string | No | 'Phone number' | |
| defaultCountry | string | No | 'AU' | — ISO 2-letter, e.g. 'AU' |
| countries | { code, dialCode, label }[] | No | DEFAULT_COUNTRIES | — override/extend the built-in list |
| required | boolean | No | false | |
| error | string | No | '' | |
| onChange | (value: string) => void | Yes |
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 PhoneNumberField from './velocity/phone-number-field/PhoneNumberField';
export default function Example() {
return (
<PhoneNumberField
onChange={() => {}}
/>
);
}Built from Phone Number Field's own prop signature and the path the CLI installs it to, so it can't drift from either.
Accessibility
- ARIA attributes
- aria-describedby, aria-hidden, aria-invalid
- Keyboard
- Built on native controls — Enter/Space work as standard
- Screen readers
- Ships screen-reader-only text
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
- useId, useState
- Breakpoints
- sm:
- Dark mode
- Carries its own dark: variants
Theming
This component paints from 7 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-200primary-300primary-500primary-600primary-700primary-800primary-950Get 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/phone-number-field/PhoneNumberField.jsx146 lines
Copy the paths
src/components/velocity/phone-number-field/PhoneNumberField.jsxVersions
2 published versions are preserved with their own access level and source hash. The CLI can pin to any version and upgrade without overwriting local edits.
- v1.0.1 Current Subscription21 Oct 2026
velocityx add phone-number-field - v1.0.0Subscription21 Oct 2026
velocityx add phone-number-field@1.0.0
Phone Number Field — questions
How do I install Phone Number Field?
Run velocityx add phone-number-field . The CLI writes the source straight into your project — it is not a runtime package dependency.
Do I need a licence for Phone Number Field?
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 Phone Number Field 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 Phone Number Field ship JavaScript to my users?
Yes. It runs in the browser (useId, useState), so it needs to hydrate — in Astro, give it a client:* directive.
Will Phone Number Field match my brand colours?
Yes. It paints entirely from your theme scale — 7 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.
Does Phone Number Field work on mobile?
It carries its own responsive rules at the sm breakpoint, so it re-flows rather than relying on the page around it to do the work.
Which version of Phone Number Field should I install?
There are 2 published versions, and the default install gives you the current one. Pin an older one with velocityx add phone-number-field@<version> , or move between them later with velocityx upgrade phone-number-field — downgrades work too.
Does Phone Number Field 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 phone-number-field- 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.
reactThe 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.
react