Phone number field Presenter Plugin

A COPRL plugin that accepts, formats, and validates phone number input.

The front-end interactions are handled by the International Telephone Input JavaScript library.

Installation

Add this line to your application's Gemfile:

gem 'phone_number_field_presenter_plugin', git: 'https://github.com/coprl/phone_number_field_plugin', require: false

And then execute:

$ bundle

Usage in POMs

Declare the plugin in your POM, plugin :phone_number_field.

Drop in phone_number_field as a replacement for a standard text_field when asking the user to provide a phone number:

form do
  phone_number_field name: :phone_number, required: true do
    label "Phone number"
    value user.phone_number
  end

  button "Save", type: :raised do
    event :click do
      updates "/users/123"
    end
  end
end

Users can pick a country code from the dropdown in the leading area of the text field or by typing a country code directly into the text field. Input is formatted as it is typed according to the format for the current country code.

The plugin submits the field's value normalized and formatted as an international phone number in standard E.164 format, with extension when applicable.

Configuration

phone_number_field supports the following additional options:

• locale: A region or region-language locale identifier, such as :en or "ja-JP", that controls in what language country names and other strings appear. If absent, locale is determined from the browser via the Intl API.
• default_country: An ISO 3166 alpha-2 country code, such as :us or "CA", used as the initially selected country code when the field has no initial value. If absent, no country is selected when the field is empty, and users must specify or select a country code.

For example,

phone_number_field locale: user.preferred_locale || :DE, default_country: user.location.country do
  label t(:phone_number)
  value user.phone_number
end

Validation

The plugin performs best-effort formatting and validation on user input.

• Numbers that are too long, too short, or otherwise invalid for the selected country mark the field as invalid and prevent submission.
• Extraneous country codes are removed.
• National numbers are prefixed with the selected country code.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/coprl/phone_number_field_plugin.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the COPRL project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.