When to use it
Use for international phone entry that needs discoverable country selection and a validated E.164 result. Persist or dial e164 only when isValid is true.
FormsApple
Phone input
Enter an international phone number with searchable countries, calling codes, formatting, validation, and E.164 output.
Apple availability
Supported native targets
Import LumenUI in the target that uses this component. iPad support follows the iOS package baseline and uses native iPad layout behavior.
iPhone · iOS 16+iPad · iPadOS 16+Mac · macOS 13+Apple Vision · visionOS 1+
Native example
Use Phone input
Use for international phone entry that needs discoverable country selection and a validated E.164 result. Persist or dial e164 only when isValid is true.
@State private var phone = LumenPhoneNumber.empty(
country: LumenPhoneCountry(
regionCode: "CO",
callingCode: "+57",
displayName: "Colombia"
)
)
LumenPhoneInput(
"Hospital or OB phone number",
value: $phone
)Reference
Public API
The primary shared and platform-specific options exposed by LumenPhoneInput.
| API | Values or type | Default | Description |
|---|---|---|---|
| value / onValueChange | LumenPhoneNumber / callback | Required | Controls the country, editable national number, validity, and normalized E.164 result. |
| countries | Platform country collection | Generated metadata | Populates the searchable country picker. |
| locale | Platform locale | Current locale | Localizes generated country names and international paste resolution. |
| description / errorMessage | String? | null | Provides supporting text or an application-owned validation message. |
| invalidNumberMessage | String | Enter a complete phone number. | Localizes metadata-backed invalid-number feedback. |
| showValidationError | Boolean | true | Lets the application defer invalid-number feedback until its chosen interaction boundary. |
| enabled / required | Boolean | true / false | Controls native disabled and required presentation. |
Native behavior
Design and accessibility
Accessibility
The country selector announces the localized country name and calling code. Flags supplement visible text and are never the only country identifier.
Shared component