--- title: "Phone Number" slug: phone-number category: component type: technical-information version: 20.0.0 tokens: 2280 source: https://ovh.github.io/design-system/v20.0.0/llms/react-components-phone-number--technical-information.txt --- # Phone Number ## PhoneNumber This component extends all the native `
` attributes. | Property | Type | Required | Default | Description | |---|---|---|---|---| | `countries` | `'id' | 'br' | 'hr' | 'li' | 'td' | 'th' | 'tr' | 'is' | 'no' | 'as' | 'by' | 'cx' | 'cy' | 'fr' | 'in' | 'to' | 'de' | 'es' | 'it' | 'nl' | 'pl' | 'pt' | 'sm' | 'md' | 'ad' | 'ae' | 'af' | 'ag' | 'ai' | 'al' | 'am' | 'ao' | 'ar' | 'at' | 'au' | 'aw' | 'ax' | 'az' | 'ba' | 'bb' | 'bd' | 'be' | 'bf' | 'bg' | 'bh' | 'bi' | 'bj' | 'bl' | 'bm' | 'bn' | 'bo' | 'bq' | 'bs' | 'bt' | 'bw' | 'bz' | 'ca' | 'cc' | 'cd' | 'cf' | 'cg' | 'ch' | 'ci' | 'ck' | 'cl' | 'cm' | 'cn' | 'co' | 'cr' | 'cu' | 'cv' | 'cw' | 'cz' | 'dj' | 'dk' | 'dm' | 'do' | 'dz' | 'ec' | 'ee' | 'eg' | 'eh' | 'er' | 'et' | 'fi' | 'fj' | 'fk' | 'fm' | 'fo' | 'ga' | 'gb' | 'gd' | 'ge' | 'gf' | 'gg' | 'gh' | 'gi' | 'gl' | 'gm' | 'gn' | 'gp' | 'gq' | 'gr' | 'gt' | 'gu' | 'gw' | 'gy' | 'hk' | 'hn' | 'ht' | 'hu' | 'ie' | 'il' | 'im' | 'io' | 'iq' | 'ir' | 'je' | 'jm' | 'jo' | 'jp' | 'ke' | 'kg' | 'kh' | 'ki' | 'km' | 'kn' | 'kp' | 'kr' | 'kw' | 'ky' | 'kz' | 'la' | 'lb' | 'lc' | 'lk' | 'lr' | 'ls' | 'lt' | 'lu' | 'lv' | 'ly' | 'ma' | 'mc' | 'me' | 'mf' | 'mg' | 'mh' | 'mk' | 'ml' | 'mm' | 'mn' | 'mo' | 'mp' | 'mq' | 'mr' | 'ms' | 'mt' | 'mu' | 'mv' | 'mw' | 'mx' | 'my' | 'mz' | 'na' | 'nc' | 'ne' | 'nf' | 'ng' | 'ni' | 'np' | 'nr' | 'nu' | 'nz' | 'om' | 'pa' | 'pe' | 'pf' | 'pg' | 'ph' | 'pk' | 'pm' | 'pr' | 'ps' | 'pw' | 'py' | 'qa' | 're' | 'ro' | 'rs' | 'ru' | 'rw' | 'sa' | 'sb' | 'sc' | 'sd' | 'se' | 'sg' | 'sh' | 'si' | 'sj' | 'sk' | 'sl' | 'sn' | 'so' | 'sr' | 'ss' | 'st' | 'sv' | 'sx' | 'sy' | 'sz' | 'tc' | 'tg' | 'tj' | 'tk' | 'tl' | 'tm' | 'tn' | 'tt' | 'tv' | 'tw' | 'tz' | 'ua' | 'ug' | 'us' | 'uy' | 'uz' | 'va' | 'vc' | 've' | 'vg' | 'vi' | 'vn' | 'vu' | 'wf' | 'ws' | 'ye' | 'yt' | 'za' | 'zm' | 'zw'[] | 'all'` | No | undefined | A specific or preset list of country to display in the selector. | | `country` | `'id' | 'br' | 'hr' | 'li' | 'td' | 'th' | 'tr' | 'is' | 'no' | 'as' | 'by' | 'cx' | 'cy' | 'fr' | 'in' | 'to' | 'de' | 'es' | 'it' | 'nl' | 'pl' | 'pt' | 'sm' | 'md' | 'ad' | 'ae' | 'af' | 'ag' | 'ai' | 'al' | 'am' | 'ao' | 'ar' | 'at' | 'au' | 'aw' | 'ax' | 'az' | 'ba' | 'bb' | 'bd' | 'be' | 'bf' | 'bg' | 'bh' | 'bi' | 'bj' | 'bl' | 'bm' | 'bn' | 'bo' | 'bq' | 'bs' | 'bt' | 'bw' | 'bz' | 'ca' | 'cc' | 'cd' | 'cf' | 'cg' | 'ch' | 'ci' | 'ck' | 'cl' | 'cm' | 'cn' | 'co' | 'cr' | 'cu' | 'cv' | 'cw' | 'cz' | 'dj' | 'dk' | 'dm' | 'do' | 'dz' | 'ec' | 'ee' | 'eg' | 'eh' | 'er' | 'et' | 'fi' | 'fj' | 'fk' | 'fm' | 'fo' | 'ga' | 'gb' | 'gd' | 'ge' | 'gf' | 'gg' | 'gh' | 'gi' | 'gl' | 'gm' | 'gn' | 'gp' | 'gq' | 'gr' | 'gt' | 'gu' | 'gw' | 'gy' | 'hk' | 'hn' | 'ht' | 'hu' | 'ie' | 'il' | 'im' | 'io' | 'iq' | 'ir' | 'je' | 'jm' | 'jo' | 'jp' | 'ke' | 'kg' | 'kh' | 'ki' | 'km' | 'kn' | 'kp' | 'kr' | 'kw' | 'ky' | 'kz' | 'la' | 'lb' | 'lc' | 'lk' | 'lr' | 'ls' | 'lt' | 'lu' | 'lv' | 'ly' | 'ma' | 'mc' | 'me' | 'mf' | 'mg' | 'mh' | 'mk' | 'ml' | 'mm' | 'mn' | 'mo' | 'mp' | 'mq' | 'mr' | 'ms' | 'mt' | 'mu' | 'mv' | 'mw' | 'mx' | 'my' | 'mz' | 'na' | 'nc' | 'ne' | 'nf' | 'ng' | 'ni' | 'np' | 'nr' | 'nu' | 'nz' | 'om' | 'pa' | 'pe' | 'pf' | 'pg' | 'ph' | 'pk' | 'pm' | 'pr' | 'ps' | 'pw' | 'py' | 'qa' | 're' | 'ro' | 'rs' | 'ru' | 'rw' | 'sa' | 'sb' | 'sc' | 'sd' | 'se' | 'sg' | 'sh' | 'si' | 'sj' | 'sk' | 'sl' | 'sn' | 'so' | 'sr' | 'ss' | 'st' | 'sv' | 'sx' | 'sy' | 'sz' | 'tc' | 'tg' | 'tj' | 'tk' | 'tl' | 'tm' | 'tn' | 'tt' | 'tv' | 'tw' | 'tz' | 'ua' | 'ug' | 'us' | 'uy' | 'uz' | 'va' | 'vc' | 've' | 'vg' | 'vi' | 'vn' | 'vu' | 'wf' | 'ws' | 'ye' | 'yt' | 'za' | 'zm' | 'zw'` | No | undefined | The controlled selected country. | | `defaultValue` | `string` | No | undefined | The initial phone number value. Use when you don't need to control the value of the phone number. | | `disabled` | `boolean` | No | undefined | Whether the component is disabled. | | `i18n` | `Partial` | No | undefined | Internal translations override. | | `invalid` | `boolean` | No | undefined | Whether the component is in error state. | | `locale` | `string` | No | undefined | The locale used for the translation of the country list and the internal elements. | | `name` | `string` | No | undefined | The name of the form element. Useful for form submission. | | `onCountryChange` | `(detail: PhoneNumberCountryChangeDetail) => void` | No | undefined | Callback fired when the country changes. | | `onValueChange` | `(detail: PhoneNumberValueChangeDetail) => void` | No | undefined | Callback fired when the value changes. | | `pattern` | `string` | No | undefined | The phone number input expected pattern. | | `readOnly` | `boolean` | No | undefined | Whether the component is readonly. | | `required` | `boolean` | No | undefined | Whether the component is required. | | `value` | `string` | No | undefined | The controlled phone number value. | ## PhoneNumberControl | Property | Type | Required | Default | Description | |---|---|---|---|---| | `clearable` | `boolean` | No | undefined | Whether the clear button is displayed. | | `loading` | `boolean` | No | undefined | Whether the component is in loading state. | ## PhoneNumberCountryList This component extends all the native `
` attributes. _No specific property._ ## Enums ### PHONE_NUMBER_COUNTRIES_PRESET - `all` = `all` ### PHONE_NUMBER_COUNTRY_ISO_CODE - `ad` = `ad` - `ae` = `ae` - `af` = `af` - `ag` = `ag` - `ai` = `ai` - `al` = `al` - `am` = `am` - `ao` = `ao` - `ar` = `ar` - `as` = `as` - `at` = `at` - `au` = `au` - `aw` = `aw` - `ax` = `ax` - `az` = `az` - `ba` = `ba` - `bb` = `bb` - `bd` = `bd` - `be` = `be` - `bf` = `bf` - `bg` = `bg` - `bh` = `bh` - `bi` = `bi` - `bj` = `bj` - `bl` = `bl` - `bm` = `bm` - `bn` = `bn` - `bo` = `bo` - `bq` = `bq` - `br` = `br` - `bs` = `bs` - `bt` = `bt` - `bw` = `bw` - `by` = `by` - `bz` = `bz` - `ca` = `ca` - `cc` = `cc` - `cd` = `cd` - `cf` = `cf` - `cg` = `cg` - `ch` = `ch` - `ci` = `ci` - `ck` = `ck` - `cl` = `cl` - `cm` = `cm` - `cn` = `cn` - `co` = `co` - `cr` = `cr` - `cu` = `cu` - `cv` = `cv` - `cw` = `cw` - `cx` = `cx` - `cy` = `cy` - `cz` = `cz` - `de` = `de` - `dj` = `dj` - `dk` = `dk` - `dm` = `dm` - `do` = `do` - `dz` = `dz` - `ec` = `ec` - `ee` = `ee` - `eg` = `eg` - `eh` = `eh` - `er` = `er` - `es` = `es` - `et` = `et` - `fi` = `fi` - `fj` = `fj` - `fk` = `fk` - `fm` = `fm` - `fo` = `fo` - `fr` = `fr` - `ga` = `ga` - `gb` = `gb` - `gd` = `gd` - `ge` = `ge` - `gf` = `gf` - `gg` = `gg` - `gh` = `gh` - `gi` = `gi` - `gl` = `gl` - `gm` = `gm` - `gn` = `gn` - `gp` = `gp` - `gq` = `gq` - `gr` = `gr` - `gt` = `gt` - `gu` = `gu` - `gw` = `gw` - `gy` = `gy` - `hk` = `hk` - `hn` = `hn` - `hr` = `hr` - `ht` = `ht` - `hu` = `hu` - `id` = `id` - `ie` = `ie` - `il` = `il` - `im` = `im` - `in` = `in` - `io` = `io` - `iq` = `iq` - `ir` = `ir` - `is` = `is` - `it` = `it` - `je` = `je` - `jm` = `jm` - `jo` = `jo` - `jp` = `jp` - `ke` = `ke` - `kg` = `kg` - `kh` = `kh` - `ki` = `ki` - `km` = `km` - `kn` = `kn` - `kp` = `kp` - `kr` = `kr` - `kw` = `kw` - `ky` = `ky` - `kz` = `kz` - `la` = `la` - `lb` = `lb` - `lc` = `lc` - `li` = `li` - `lk` = `lk` - `lr` = `lr` - `ls` = `ls` - `lt` = `lt` - `lu` = `lu` - `lv` = `lv` - `ly` = `ly` - `ma` = `ma` - `mc` = `mc` - `md` = `md` - `me` = `me` - `mf` = `mf` - `mg` = `mg` - `mh` = `mh` - `mk` = `mk` - `ml` = `ml` - `mm` = `mm` - `mn` = `mn` - `mo` = `mo` - `mp` = `mp` - `mq` = `mq` - `mr` = `mr` - `ms` = `ms` - `mt` = `mt` - `mu` = `mu` - `mv` = `mv` - `mw` = `mw` - `mx` = `mx` - `my` = `my` - `mz` = `mz` - `na` = `na` - `nc` = `nc` - `ne` = `ne` - `nf` = `nf` - `ng` = `ng` - `ni` = `ni` - `nl` = `nl` - `no` = `no` - `np` = `np` - `nr` = `nr` - `nu` = `nu` - `nz` = `nz` - `om` = `om` - `pa` = `pa` - `pe` = `pe` - `pf` = `pf` - `pg` = `pg` - `ph` = `ph` - `pk` = `pk` - `pl` = `pl` - `pm` = `pm` - `pr` = `pr` - `ps` = `ps` - `pt` = `pt` - `pw` = `pw` - `py` = `py` - `qa` = `qa` - `re` = `re` - `ro` = `ro` - `rs` = `rs` - `ru` = `ru` - `rw` = `rw` - `sa` = `sa` - `sb` = `sb` - `sc` = `sc` - `sd` = `sd` - `se` = `se` - `sg` = `sg` - `sh` = `sh` - `si` = `si` - `sj` = `sj` - `sk` = `sk` - `sl` = `sl` - `sm` = `sm` - `sn` = `sn` - `so` = `so` - `sr` = `sr` - `ss` = `ss` - `st` = `st` - `sv` = `sv` - `sx` = `sx` - `sy` = `sy` - `sz` = `sz` - `tc` = `tc` - `td` = `td` - `tg` = `tg` - `th` = `th` - `tj` = `tj` - `tk` = `tk` - `tl` = `tl` - `tm` = `tm` - `tn` = `tn` - `to` = `to` - `tr` = `tr` - `tt` = `tt` - `tv` = `tv` - `tw` = `tw` - `tz` = `tz` - `ua` = `ua` - `ug` = `ug` - `us` = `us` - `uy` = `uy` - `uz` = `uz` - `va` = `va` - `vc` = `vc` - `ve` = `ve` - `vg` = `vg` - `vi` = `vi` - `vn` = `vn` - `vu` = `vu` - `wf` = `wf` - `ws` = `ws` - `ye` = `ye` - `yt` = `yt` - `za` = `za` - `zm` = `zm` - `zw` = `zw` ### PHONE_NUMBER_I18N - `countrySelect` = `phoneNumber.country.select` ### PHONE_NUMBER_PARSING_ERROR - `invalidCountry` = `invalid-country` - `invalidLength` = `invalid-length` - `notANumber` = `not-a-number` - `tooLong` = `too-long` - `tooShort` = `too-short` - `unknownError` = `unknown-error`