icon Phone

Allows a user to enter a phone value. The field can be restricted to only accept phone numbers from certain countries.

This page contains a detailed description of the field properties and JavaScript samples which you can use with this field.

Phone field

Common Properties

Phone Properties

Here you can find properties specifically related to the Phone field.

Countries

Specify which country codes are accepted in the field, using the search box to search through all possible regional codes. You can use the Select all option to allow choosing any country without restrictions.

Phone field

JavaScript framework

In this section, you can find basic examples of how to work with the field using JavaScript.

For more examples, check out Working with form fields in JavaScript article. If you are not familiar with the JavaScript framework, get started with the JavaScript basics.

Note

The field is only accessible once the form is rendered, so all calls to the field must be inside fd.rendered event:

fd.rendered(() => {
    // make field required
    fd.field('Field1').required = true;
});

Get or set field value

Get or set the Phone field value. Note that the value is stored as a string, not an integer.

// get field value
fd.field('Field1').value;

// set field value
fd.field('Field1').value = '+1 (800) 555 1234';

Handle change event

Execute a function when a field value has been changed:

fd.field('Field1').$on('change', value => {
    // log changes to browser's console
    console.log('New value: ' + value);
});

Make field required

Make a field required or optional:

// make field required
fd.field('Field1').required = true;

// make field not required
fd.field('Field1').required = false;

Disable field

Make a field non-editable. The field value can still be changed with JavaScript and saved:

// disabled field
fd.field('Field1').disabled = true;

// enable field
fd.field('Field1').disabled = false;

Get HTML element

Access HTML element inside the field in order to modify it, hide it, or do something else.

// access field's control
let htmlElement = fd.field('Field1').$el;

// access field's block, which includes title and control
let htmlParentElement = fd.field('Field1').$parent.$el;

Hide field

Hide a field from a user. The field value can still be accessed and changed with JavaScript:

// hide field
fd.field('Field1').hidden = true;

// show field
fd.field('Field1').hidden = false;