This document tries to explain the Schema fields and their usage.
The content schema is used to explain the fields in this document.
URL
This field will take the URL as input.
{
"type": "String",
"fieldType": "url",
"ref": "",
"options": [],
"multiple": false,
"validation": [
{
"required": false
}
],
"isDefault": false,
"label": "Place your URL",
"key": "testurl"
}
The field label will turn red if a URL is not entered in this field.
Text
This field is used for entering the text values.
{
"type": "String",
"fieldType": "text",
"ref": "",
"options": [],
"multiple": false,
"validation": [
{
"required": false
//"maxlength": 250
}
],
"isDefault": false,
"label": "Place your text",
"key": "testtext"
}
[Optional] You can set the maxlength property under the validation array. This will make the field label turn red if you enter more than the maxlength number of characters.
Textarea
This field will display a text box. You also see the number of characters this textbox can take on the bottom right corner. You cannot add more than the maxlength number of characters.
{
"type": "String",
"fieldType": "textarea",
"ref": "",
"options": [],
"multiple": false,
"validation": [
{
"required": true,
"maxlength": 250
}
],
"isDefault": false,
"label": "Place your text in the area",
"key": "testtextarea"
}
The maxlength is a mandatory property for textarea fieldType.
Rich Text
Use this field type to enable the formatting of the text entered.
{
"type": "String",
"fieldType": "richtext",
"ref": "",
"options": [],
"multiple": false,
"validation": [
{
"required": false
}
],
"isDefault": false,
"label": "Place your rich text here",
"key": "testrichtext"
}
Media Embed
Use this option to Embed media content or Insights Dashboards and so on.
The Embed field in Edit mode.
The Embed field in View mode.
{
"type": "String",
"fieldType": "embed",
"ref": "",
"options": [],
"multiple": false,
"validation": [
{
"required": false
}
],
"isDefault": false,
"label": "Embed your file here",
"key": "testembed"
}
File
Use this field type to allow uploading files.
File upload in Edit mode.
File upload in view mode.
Click on the Browse button.
Choose a file/image or click on Upload to upload your own file.
After selecting the file/image of your choice. Click on the OK button.
{
"type": "String",
"fieldType": "file",
"ref": "",
"options": [
{
"multiple": "true"
},
{
"removeAfterUpload": true
},
{
"mimeTypes": [
"image",
"application"
]
}
],
"multiple": false,
"validation": [
{
"required": true
}
],
"isDefault": false,
"label": "Upload your file here",
"key": "testfile"
},
The options array has the multiple, removeAfterUpload, and mimeTypes properties.
Property | Description |
|---|---|
| |
| |
| |
| |
|
Date
Use this field type for the Date picker widget.
DateTime
Use this field type for the Date and Time picket widget.