logo dile-components dile-components

dile-input-phone

This component extends from dile-input.

Phone number input made of a searchable selector of international prefixes (dile-phone-prefix-select) and a field for the number. The prefix selector is optional: use noPrefix when you only need the number.

To leave room for the number on small screens, the prefix selector is narrow and shows only the prefix once selected (+34), while its list of countries opens wider (+34 Spain). Screen readers get the country too: the accessible name of the selected prefix is the full text (+34 Spain).

It shows the numeric keyboard on mobile devices, lets the browser autocomplete the phone and only accepts the characters used to write phone numbers (digits, spaces, +, -, (, ) and .).

Installation

npm i @dile/utils

Usage

Import the component.

import '@dile/utils/components/input-phone/input-phone.js';

Use the component.

<dile-input-phone name="phone" label="Phone" country="ES"></dile-input-phone>

The value

The value depends on whether the prefix selector is used:

Mode User input value
With prefix (default) +34 and 600 12 34 56 "+34600123456"
With noPrefix 600 12 34 56 "600123456"

When the value is set from outside (an attribute, DileForm.setData()...), an international value like "+34600123456" is split into the prefix and the number to display. International calling codes are designed so that none of them is the beginning of another, so the split is always unambiguous. For prefixes shared by several countries (+1, +44...), the current country is kept if it has that prefix; otherwise, the main country of the prefix is selected. Values that are not international are displayed as they are, without being rewritten.

Prefix and number stored separately

When your backend stores the prefix and the number in separate fields, use two fields in your form:

<dile-phone-prefix-select name="phone_prefix" label="Prefix"></dile-phone-prefix-select>
<dile-input-phone noPrefix name="phone_number" label="Phone"></dile-input-phone>

Properties

Besides the dile-input properties (label, accessibleLabel, name, value, placeholder, disabled, errored, message, hideErrorOnInput...):

Property Type Default Description
noPrefix Boolean false Hides the prefix selector. The value is then the plain number.
country String undefined ISO code of the country of the prefix, like "ES". Set it to preselect a default prefix. It changes when the user picks another prefix.
language String "en" Language of the prefix selector: "es" or "en".
priorityCountries String "" ISO codes of the countries listed first in the prefix selector, separated by |. Exposed via priority-countries.
prefixPlaceholder String "Prefix" / "Prefijo" Placeholder of the prefix selector.
prefix String undefined Read only. Prefix of the selected country, like "+34".
number String "" Read only. Digits of the number, without the prefix.

Methods

Events

document.querySelector('dile-input-phone').addEventListener('element-changed', (e) => {
  const phone = e.target;
  console.log(e.detail.value, phone.prefix, phone.number, phone.country, phone.isValid());
});

CSS Custom Properties

Custom property Description Default
--dile-input-phone-prefix-width Width of the prefix selector 6.5rem
--dile-input-phone-list-width Minimum width of the list of countries, which can be wider than the prefix selector 16rem
--dile-input-phone-gap Space between the prefix selector and the number field 0.5rem

The number field uses the dile-input custom properties and the prefix selector the ones of dile-select-search.

dile-input-phone demos

With a default country

<script type="module">
  import '@dile/utils/components/input-phone/input-phone.js';
</script>
<dile-input-phone name="phone" label="Phone" country="ES" placeholder="600 12 34 56"></dile-input-phone>

Spanish with priority countries

<dile-input-phone language="es" priority-countries="ES|MX|AR" label="Teléfono"></dile-input-phone>

Without prefix

<dile-input-phone noPrefix label="Phone" placeholder="600 12 34 56"></dile-input-phone>

Value, parts and validation

<script type="module">
  import { LitElement, html } from 'lit';

  class InputPhoneDemo extends LitElement {
    static properties = {
      info: { type: String },
    };
    render() {
      return html`
        <dile-input-phone
          label="Phone"
          value="+447700900123"
          @element-changed=${this.changed}
        ></dile-input-phone>
        <p>${this.info}</p>
      `;
    }
    changed(e) {
      const phone = e.target;
      this.info = `Value: ${e.detail.value} / Prefix: ${phone.prefix} / Number: ${phone.number} / Valid: ${phone.isValid()}`;
    }
  }
  customElements.define('input-phone-demo', InputPhoneDemo);
</script>
<input-phone-demo></input-phone-demo>

Styled

<style>
  .styled-phone {
    --dile-input-phone-prefix-width: 8rem;
    --dile-input-phone-list-width: 20rem;
    --dile-input-border-color: #39c;
  }
</style>
<dile-input-phone class="styled-phone" label="Phone" country="MX"></dile-input-phone>

Errored

<dile-input-phone errored message="Invalid phone number" hideErrorOnInput label="Phone" country="ES"></dile-input-phone>