Sample Form Configuration | Sunbird inQuiry

Last updated 2 years ago

Field Configuration Properties:

How to configure different types of fields

In QuestionSet Editor these are the following of fields which we are using:

Text

Textarea

Richtext

Keywords

Multi Select

Single Select

Topic Selector

Checkbox

Timer

How to define the width of fields and add asterisks(*) on field label

renderHints is the property defines whether the fields should take space of two column or one column and to add asterisks(*) in the label of field to make it look required field

Two column space fields should have renderHints as:

One column space fields should have renderHints as:

For adding asterisks in the Label of field

Note: sb-g-col-lg-1 or sb-g-col-lg-2 can be used with combination of required as:

How to add validations on fields

Validation property defines the different types of validations which can be done on fields

We are using required, maxLength,compare

required: for making the field to be required you need to add the required validations as:

maxLength: for adding restriction of length on field text, textarea, richtext.

compare: for comparing one field with another.

In the case of timer warningTime should be less than or equal to maxTime so in warning time we can add the compare validation as:

Sample QuestionSet form

Sample Section Form

Sample Publish Check List

Last updated 2 years ago

{ "code": string, // property to match the backend schema ("name", "description", etc...) "name": string, // name of the field ("Name", "Board", "Medium", "License", "Copyright Year", etc) "label": string, // title of the field "placeholder": string, // placeholder text to appear within the field "description": string, // to specify description about the field and to show as tooltip "default": string, // specify default value "dataType": string, // to specify the datatype of the field outcome ("list", "number", "text") "inputType": string, // to map the field type and the component ("text", "textarea", "select", "nestedselect", etc) "editable": boolean, // to enable or disable the field "required": boolean, // to specify if the field is mandatory or not (currently, not used.) "visible": boolean, // to hide or show the field "depends": array, // array of "code" to specify that this field is dependant on other fields "range": array, // Array or array of objects of inputs to fields such as "select", "nestedselect", "multiselect" "options": array/function/map, // to specify the inputs to fields such as "select", "nestedselect", "multiselect", "framework", "frameworkCategorySelect" "renderingHints": json, // to specify any additional configuration ex:({"class": "sb-g-col-lg-1 required"}) "validations": array // Array of objects to specity the validations of a field. Each validation object takes properties such as "type", "message", "value", "criteria" "output": string, // this field is specific to framework terms and it's associations. The field will decide the property for the field outcome ex:("name", "label", "identifier") "sourceCategory": string, // this field is specific to framework categories to map the category and association ex: (to map "subjectIds" with "subject" or to map "targetMediumIds" with "medium") "terms": array, // Array or array of object of inputs to fields related to framework and it's categories }