icon Single Choice

The Single Choice field allows a user to select only one option from a predefined list of options.

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

Single Choice field

Common Properties

Single Choice Properties

Here you can find properties specifically related to the Single Choice field.

Data Source

Select the source from which the field fetches the list of options.

To access the property, click a field on the form to open the property panel: Data SourceType.

Data source type property

Static List

The list of options is static and stored on a form.

Add a list of options to the Options property. Each option should be on a new line, as shown here:

Static list options

Enable Allow user value to allow users to enter a custom value that is not included in the list of options:

Allow user value

Excel

The list of options is populated from an Excel file stored in OneDrive. The Excel file holds static information or can be dynamically updated with data from a SharePoint list, a SQL database, Dynamics 365, or any other source using Power Automate (MS Flow).

To retrieve options from an Excel file:

  1. Click this icon in the Account property and connect your OneDrive account:

    OneDrive account
  2. Select the path to the Excel file in the File property.

    File property

    Other properties are not available until the file is selected.

  3. If there are multiple sheets in the Excel file, you can select which sheet to use. The first sheet is selected by default.

    Sheet property
  4. If the data is formatted as a table, select the table name in the Table property. Otherwise, the property is not available and you can skip this step.

    Table property
  5. The display text and the actual value of the field may be different.

    Select the column with the values that will be displayed in the drop-down list in the Text column property:

    Text column property

    And in the Value column property, specify the column whose values will be saved when the form is submitted. These values will be used in Power Automate (MS Flow) or Zapier.

    Value column property
  6. In the Caching property you can specify how long the data will be stored in the cache. If the page with the form is refreshed within this time, new values will not be loaded.

    The data is stored for 600 seconds (10 minutes) by default.

    Caching property

Columns

Specify the layout of the options. By default, the options are grouped into three columns.

Columns property

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(function(){
    //make field required
    fd.field('Field1').required = true;
});

Get or set field value

Get or set the Single Choice field value:

//return field value as a string
fd.field('Field1').value;

//set field value
fd.field('Field1').value = 'Item 2';

Handle change event

Execute a function when a field value has been changed:

fd.field('Field1').$on('change', function(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;

Hide field

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

//hide field
$(fd.field('Field1').$parent.$el).hide();

//show field
$(fd.field('Field1').$parent.$el).show();

Allow custom values

Define whether a user is allowed to enter a custom value that is not included in the list of options.

fd.field('Field1').allowUserValue = true;

Change field options

Change the Single Choice field options:

fd.field('Field1').options = ['New option 1', 'New option 2', 'New option 3'];

User values

Define whether a user is allowed to enter a custom value that is not included in the list of options:

//turn on custom values
fd.field('Field1').allowUserValue = true;

//turn off custom values
fd.field('Field1').allowUserValue = false;

Columns

Specify the number of columns by which the options will be grouped:

//group by 2 columns
fd.field('Field1').columnsNumber = 2;