Input Types- Pre populated Lists
- Arunima Kurup Prasad
- Amish Ladhu
Platform URL | https://[enterprise].cvtr.io/v2/forms |
|---|---|
API Endpoints | Not Applicable |
Epic | |
Document status | READY FOR REVIEW |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Amish Ladhu |
Related Content |
Feature Overview
There are a few form ‘choice’ input types that are pre-populated with values, making it easier for customers to include common list options within their form without the need to create these dropdowns manually.
Country List
The ‘CountryList’ field provides a pre-populated dropdown/choice list of countries, whereby the full name of the country acts as the label, and the country code acts as the value.
Field Settings
Field Name | Required | Notes |
Type | Country List | |
Name | The default value is ‘country’, however this can be changed if required. | |
Enabled | To display the field on the form, the toggle should be set to ‘Enabled’. | |
Required Toggle | If the field is a requirement for the form to be completed, this toggle should be on. | |
Required Message | If the field is required, the validation message can be customised. | |
Label | The default value is ‘Country’, however this can be changed or removed if required. | |
Placeholder | The placeholder attribute specifies a short hint that describes the expected value of the field. | |
CSS Class | A custom CSS class can be added to the HTML wrapper of the field if required for custom CSS targeting and styling. |
Settings Dialog
Import JSON
On the field ‘Settings’, in the ‘Choices’ tab there is a text area which allows users to import their own values via JSON array. Once JSON has been input into the text area, and the ‘Import’ button is clicked, the JSON values will append values to the end of any existing values. Information about JSON formatting is detailed in the tooltip.
Manual Value Editing
Directly below the JSON ‘Import’ button is the list of values/labels which for this field are pre-populated with countries.
Field Name | Required | Notes |
Value | The value that will be stored with the lead once the form is submitted. | |
Label | This label will display as the label shown on the form dropdown. | |
‘Add’ button | Once ‘Value’ and ‘Label’ have been completed, the ‘Add’ button adds the value to the existing list. | |
‘Remove’ button | Remove any unwanted values. | |
‘Move’ button | Click and hold this button to drag an item up and down in the list, which will determine it’s position in the list when viewing the form itself. |
US State List
The ‘UsStateList’ field provides a pre-populated dropdown/choice list of all US states, whereby the full name of the state acts as the label, and the state code acts as the value.
Field Settings
Field Name | Required | Notes |
Type | UsStateList | |
Name |
| This value is set to ‘State’ and cannot be changed. |
Enabled | To display the field on the form, the toggle should be set to ‘Enabled’. | |
Required Toggle | If the field is a requirement for the form to be completed, this toggle should be on. | |
Required Message | If the field is required, the validation message can be customised. | |
Label | The default value is ‘State’, however this can be changed or removed if required. | |
Placeholder | The placeholder attribute specifies a short hint that describes the expected value of the field. | |
CSS Class | A custom CSS class can be added to the HTML wrapper of the field if required for custom CSS targeting and styling. |
Settings Dialog
Import JSON
On the field ‘Settings’, in the ‘Choices’ tab there is a text area which allows users to import their own values via JSON array. Once JSON has been input into the text area, and the ‘Import’ button is clicked, the JSON values will append values to the end of any existing values. Information about JSON formatting is detailed in the tooltip.
Manual Value Editing
Directly below the JSON ‘Import’ button is the list of values/labels which for this field are pre-populated with countries.
Field Name | Required | Notes |
Value | The value that will be stored with the lead once the form is submitted. | |
Label | This label will display as the label shown on the form dropdown. | |
‘Add’ button | Once ‘Value’ and ‘Label’ have been completed, the ‘Add’ button adds the value to the existing list. | |
‘Remove’ button | Remove any unwanted values. | |
‘Move’ button | Click and hold this button to drag an item up and down in the list, which will determine it’s position in the list when viewing the form itself. |
Summary
Functionality | User Story | |
|---|---|---|
| 1 | ‘CountryList’ Field | Allow users to add the ‘CountryList’ field to a form, and then edit it’s values as required. |
| 2 | ‘UsStateList’ Field | Allow users to add the ‘UsStateList’ field to a form, and then edit it’s values as required. |
User Permissions
Admin, agency users and creative managers have access to global forms.
Agency users can perform edit actions only if access is enabled at enterprise level.