This field plug-in allows for choice lists to be presented in the form of a table. The table can be created from correctly formatted static or pre-loaded choices. The table further allows for sorting for each column and also searching for across the table. See the Parameters section below.
| Feature / Property | Support |
|---|---|
| Supported field type(s) | select_one select_multiple |
| Default values | No |
| Custom constraint message | Yes |
| Custom required message | Yes |
| Read only | No |
Using multiple pre-load data columns as labels with the search() function is also not supported. Instead, you will store a delimited table in a single column of pre-load data. See below and the wiki for more.
- Download the test form extras/sample-form from this repo and upload it to your SurveyCTO server.
- Download the table-list.fieldplugin.zip file from this repo, and attach it to the test form on your SurveyCTO server.
- Make sure to provide the correct parameters (see below).
| Key | Value |
|---|---|
delimiter |
Used to set the delimiter used in the choice label column (or column of pre-loaded data that contains the table). |
headers |
A comma separated list of table headers. The number of these should match the expected number of columns in the choice label column (or column of csv or dataset) |
Example:
If you have an appearance ofcustom-table-list(delimiter='|', headers = 'ID, Description, Colour')the corresponding choice list could look like this:
| list_name | value | label |
|---|---|---|
| product | 1 | 1 | Digissim | Blue |
The values in the label column will fall under the columns represented by the values in the headers parameter. This will display the table below.
| ID | Description | Colour |
|---|---|---|
| 1 | Digissim | Blue |
You can read more about how to use this plugin here (includes a downloadable step-by-step breakdown of using this field plug-in).
-
Sample form
You can find a form definition in this repo here: extras/sample_form. -
Developer documentation
More instructions for developing and using field plug-ins can be found here: https://github.com/surveycto/Field-plug-in-resources -
User documentation How to get started using field plug-ins in your SurveyCTO form. (https://docs.surveycto.com/02-designing-forms/03-advanced-topics/06.using-field-plug-ins.html)