Phone Number Input

Summary

Default

NOTE: Error state is handled by default, validating length (too long or too short) relative to the selected country’s phone format and enforcing numeric-only values for all countries.

<%= pb_rails("phone_number_input", props: {
    id: "hello",
}) %>

Preferred Countries

Preferred countries will display in the order they are listed with the first country preselected, and all non-preferred countries listed alphabetically below in the remaining dropdown.

<%= pb_rails("phone_number_input", props: {
    initial_country: "br",
    preferred_countries: ['us', 'br', 'ph', 'gb']
}) %>

Initial Country

Setting an initial country preselects that country within the input as well as the country dropdown.

<%= pb_rails("phone_number_input", props: {
    initial_country: "br"
}) %>

Only Countries

Limiting countries removes all countries from the dropdown except your selections.

<%= pb_rails("phone_number_input", props: {
    initial_country: "br",
    only_countries: ['us', 'br']
}) %>

Exclude Countries

Excluding countries removes the selected countries from the dropdown.

<%= pb_rails("phone_number_input", props: {
    initial_country: 'gb',
    exclude_countries: ['us', 'br']
}) %>

Form Validation

<form id="example-form-validation" action="" method="get">
    <%= pb_rails("phone_number_input", props: { 
        id: "validation", 
        initial_country: "af", 
        value: "", 
        required: true 
    }) %>
    <%= pb_rails("button", props: {html_type: "submit", text: "Save Phone Number"}) %>
</form>

<%= javascript_tag do %>
    document.addEventListener('DOMContentLoaded', function () {
        const form = document.querySelector('#example-form-validation');
        
        // Wait for React component to mount
        function waitForComponent() {
            const phoneInput = form.querySelector('#validation');
            
            if (!phoneInput) {
                setTimeout(waitForComponent, 100);
                return;
            }
            
            // Wait for intl-tel-input to initialize, then focus and blur to trigger validation
            setTimeout(function() {
                phoneInput.focus({ preventScroll: true });
                setTimeout(function() {
                    phoneInput.blur();
                }, 100);
            }, 500);
        }
        
        waitForComponent();
        
        // Prevent form submission if there are validation errors
        form.addEventListener('submit', function (e) {
            if (e.target.querySelectorAll('[error]:not([error=""])').length > 0) {
                e.preventDefault();
            }
        });
    })
<% end %>

Format as You Type

NOTE: the number in the React onChange event will not include formatting (no spaces, dashes, and parentheses). For Rails, the value will include formatting and its value must be sanitized manually.

<%= pb_rails("phone_number_input", props: {
    id: "phone_number_input",
    format_as_you_type: true
}) %>

<%= pb_rails("button", props: {id: "clickable", text: "Save Phone Number"}) %>

<%= javascript_tag do %>
    document.querySelector('#clickable').addEventListener('click', () => {
        const formattedPhoneNumber = document.querySelector('#phone_number_input').value
        const unformattedPhoneNumber = formattedPhoneNumber.replace(/\D/g, "")

        alert(`Formatted: ${formattedPhoneNumber}. Unformatted: ${unformattedPhoneNumber}`)
    })
<% end %>

Strict Mode

With format_as_you_type

Ignore any irrelevant characters and cap the length at the maximum valid number length.

This can be combined with format_as_you_type / formatAsYouType.

<%= pb_rails("phone_number_input", props: {
    strict_mode: true,
}) %>

<%= pb_rails("body", props: { text: "With format_as_you_type" }) %>

<%= pb_rails("phone_number_input", props: {
    strict_mode: true,
    format_as_you_type: true,
}) %>

Hidden Inputs

The hidden_inputs boolean prop generates two hidden input fields, {field_name}_full and {field_name}_country_code. The value passed when the form is submitted contains the full phone number including the country code. Because it requires the submission of a form to function, only use this prop on Rails phone number elements within html form tags <form>/<form> or pb_forms. Read the intl-tel-input docs for more information.

<%= pb_rails("phone_number_input", props: {
    hidden_inputs: true,
    id: "hidden_inputs",
    name: "hidden_inputs",
}) %>

Country Search

Set country_search / countrySearch to true to allow users to search for a specific Country within the dropdown. If the range of countries has been limited, only the selected countries will be searchable.

<%= pb_rails("phone_number_input", props: {
    country_search: true, 
    id: "country-search",
}) %>

<%= pb_rails("phone_number_input", props: {
    country_search: true, 
    id: "country-search-limited",
    only_countries: ["br", "us", "ph", "gb"],
}) %>

Required Indicator

The requiredIndicator/required_indicator prop displays a red asterisk (*) next to the label, visually indicating that the field is required. This is purely visual and does not enforce validation.

You can use requiredIndicator/required_indicator with any validation approach: HTML5 validation via the required prop, client-side validation, or backend validation. For this reason, it works independently and doesn't need to be paired with the required prop.

<%= pb_rails("phone_number_input", props: {
  id: "phone_number_input_required_indicator",
  label: "Required Phone Number",
  required_indicator: true,
}) %>

Available Props

Props	Type	Values
align_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
align_items	enum \| responsive	start end center
border_radius	enum	none xs sm md lg xl rounded
cursor	enum	auto default none contextMenu help pointer progress wait cell
dark	boolean	true false
flex	enum \| responsive	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_direction	enum \| responsive	row column rowReverse columnReverse
flex_wrap	enum \| responsive	wrap nowrap wrapReverse
justify_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
line_height	enum	loosest looser loose normal tight tighter tightest
margin_right	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_top	array	none xxs xs sm md lg xl
margin_bottom	array	none xxs xs sm md lg xl
margin_x	array	none xxs xs sm md lg xl
margin_y	array	none xxs xs sm md lg xl
margin	array	none xxs xs sm md lg xl
width	string
min_width	string
max_width	string
gap	string \| responsive
column_gap	string \| responsive
row_gap	string \| responsive
number_spacing	enum	tabular
order	enum \| responsive	none first 1 2 3 4 5 6 7 8 9 10 11 12
overflow_x	enum	scroll visible hidden auto
overflow_y	enum	scroll visible hidden auto
overflow	enum	scroll visible hidden auto
padding_right	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_top	array	none xxs xs sm md lg xl
padding_bottom	array	none xxs xs sm md lg xl
padding_x	array	none xxs xs sm md lg xl
padding_y	array	none xxs xs sm md lg xl
padding	array	none xxs xs sm md lg xl
position	enum	relative absolute fixed sticky static
shadow	enum	none deep deeper deepest
text_align	enum \| responsive	start end left right center justify justifyAll matchParent
truncate	enum	none 1 2 3 4 5
vertical_align	enum \| responsive	baseline super top middle bottom sub text-top text-bottom
z_index	enum \| responsive	1 2 3 4 5 6 7 8 9 10 max
top	enum \| object	xxs xs sm md lg xl xxl
inset	boolean	true false
right	enum \| object	xxs xs sm md lg xl xxl
bottom	enum \| object	xxs xs sm md lg xl xxl
left	enum \| object	xxs xs sm md lg xl xxl
height	string
max_height	string
min_height	string
hover	object
group_hover	boolean	true false

Props	Type	Values	Default
disabled	boolean	true false	false
error	string
hidden_inputs	boolean	true false	false
initial_country	string
is_valid	function
label	string
name	string
on_change	reactnode
on_validate	callback<boolean, void>
only_countries	array
exclude_countries	array
preferred_countries	array
required	boolean	true false	false
required_indicator	boolean	true false	false
value	string
format_as_you_type	boolean	true false	false
strict_mode	boolean	true false	false
country_search	boolean	true false	false

Contribute to Playbook

When you start designing a new feature, you may come across a Design Token or Component that isn’t defined in Playbook. If so, you should open an issue or reach out to the team to make a contribution.

Contribute on GitHub

As the highest-rated residential remodeler in the nation, our international technology team builds a custom suite of products that continuously transform our business.

Power

Tech @ Power

Open Positions

About Power

Connect

Github

Connect Chat

Phone Number Input

Available Props

align_content

align_items

border_radius

cursor

dark

flex

flex_direction

flex_wrap

justify_content

line_height

margin_right

margin_left

margin_top

margin_bottom

margin_x

margin_y

margin

width

min_width

max_width

gap

column_gap

row_gap

number_spacing

order

overflow_x

overflow_y

overflow

padding_right

padding_left

padding_top

padding_bottom

padding_x

padding_y

padding

position

shadow

text_align

truncate

vertical_align

z_index

top

inset

right

bottom

left

height

max_height

min_height

hover

group_hover

disabled

error

hidden_inputs

initial_country

is_valid

label

name

on_change

on_validate

only_countries

exclude_countries

preferred_countries

required

required_indicator

value

format_as_you_type

strict_mode

country_search

Contribute to Playbook

Power

Connect