Phone Input
A country selector and national number field producing an E.164 value, backed by a filterable listbox.
Preview
- No countries found.
Controls
Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.
Installation
php artisan ui:add phone-input
Behavior layer (Alpine)
This component installs a self-registering Alpine module to
resources/js/ui/phone-input.js. Import the behavior layer once
from your bundle so it loads (it hooks alpine:init):
import './phone-input.js';
Registry contract
Install confidence
php artisan ui:add phone-input
writes only the generated targets below. The CLI validates each file hash before writing and
prompts before replacing local changes unless --force is used.
- Version
- 1.0.1
- License
- open
- Stability
- stable
- Contract
- v2
- Foundation
- ≥ 1.0.0
| Type | Generated target |
|---|---|
| blade | resources/views/components/ui/phone-input.blade.php |
| js | resources/js/ui/phone-input.js |
Registry dependencies
None.
Package dependencies
composer: jml/brok:^1.0
npm: alpinejs
Guidance
Specialized inputCollect constrained information with error-reducing formatting.
Use when
- Use when formatting, validation, or constrained entry meaningfully reduces errors, such as OTP, phone, currency, password, or numeric entry. Do not add specialized behavior if a plain field would be simpler and more forgiving.
Avoid when
- Avoid using phone-input as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
- Task length
- short
- Interaction cost
- medium
- Interruptiveness
- none
- Input precision
- precise
- Mobile / touch risk
- medium
- Accessibility risk
- high
- Needs background context
- No
- Comparison needed
- No
Preferred alternatives
- Plain text or number field with validation
Anti-patterns
- Adding formatting behavior that makes correction harder
API
manifest knowledge + registry-derived coverageProps
| Prop | Type / values | Default | Description |
|---|---|---|---|
| name | mixed|null | null | Declared by @props in the registry Blade source. |
| value | string | Declared by @props in the registry Blade source. | |
| defaultCountry | string | US | Declared by @props in the registry Blade source. |
| placeholder | string | Phone number | Declared by @props in the registry Blade source. |
Slots
Components use the default Blade slot unless a documented subcomponent is installed by the registry item.
Data slots
phone-input
phone-input-listbox
phone-input-listbox-wrapper
phone-input-number
phone-input-trigger
Capabilities
Behavior
- Uses server-rendered Blade and semantic HTML.
- Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
- Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.
Usage
<x-ui.phone-input name="phone" default-country="GB" class="w-80" />
Accessibility & localization
data-slot
Keyboard focus-visible
Localized labels
- Accessibility target: wcag-2.2-aa-target.
- Uses semantic HTML and a stable
data-slotattribute for styling/scripting hooks. - Focus-visible rings use the
ringtoken so keyboard focus is always visible. - Disabled and invalid states are conveyed to assistive tech, not by color alone.
- Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
- Labels go through
__()and the component uses logical properties (ms-*,text-start,start-*) so it mirrors correctly — flip the preview to RTL to confirm.
Source
The exact, editable file ui:add writes
into your app — copy it or own the whole thing. Previews
render this same code; there are no preview-only components.
Changelog
Current version: v1.0.1. See the site changelog for the full release history.