Skip to main content
Version: Latest

Built-In Property Editors

Following is a list of built-in property editors available and their value formats.

Text Input​

Text Input Interface

Widget​

text

Default Value​

String

Rich Text Input V2​

WARNING

rich_text was deprecated. Use rich_text_v2 instead for new custom tools. It's a direct replacement with the same HTML string format.

Rich Text Input Interface

Widget​

rich_text_v2

Default Value​

String

HTML Input​

HTML Input Interface

Widget​

html

Default Value​

String

Color Picker​

Color Picker Interface

Widget​

color_picker

Default Value​

String

Valid Values​

  • HEX Format #FFF000
  • RGB Format rgba(0,0,0,0.5)

Text Alignment​

Text Alignment Interface

Widget​

alignment

Default Value​

String

Valid Values​

  • left
  • center
  • right

Font Family​

Font Family Interface

Widget​

font_family

Default Value​

JSON

Valid Value​

{
"label": "Arial",
"value": "arial,helvetica,sans-serif"
}

Border​

Border Interface

Widget​

border

Default Value​

JSON

Valid Value​

{
"borderTopWidth": "0px",
"borderTopStyle": "solid",
"borderTopColor": "#CCC",
"borderLeftWidth": "0px",
"borderLeftStyle": "solid",
"borderLeftColor": "#CCC",
"borderRightWidth": "0px",
"borderRightStyle": "solid",
"borderRightColor": "#CCC",
"borderBottomWidth": "0px",
"borderBottomStyle": "solid",
"borderBottomColor": "#CCC"
}

Counter​

Counter Interface

Widget​

counter

Default Value​

String

Example Values​

10 25 50 etc


Image Uploader​

Image Uploader Interface

Widget​

image

Default Value​

JSON

Valid Value​

{
"url": "http://via.placeholder.com/350x150"
}

Toggle​

Toggle Interface

Widget​

toggle

Default Value​

Boolean

Valid Values​

  • true
  • false

Link Interface

Widget​

link

Default Value​

JSON

Valid Values​

{
"name": "web",
"values": {
"href": "http://google.com",
"target": "_blank"
}
}

Return Value​

{
"url": "http://google.com",
"target": "_blank"
}

Dropdown Interface

Widget​

dropdown

The dropdown editor needs options to be passed as data. Learn more at: Passing Data to Property Editors


Date / Time​

Date Time Interface

Widget​

datetime

Default Value​

String

Widget Params​

hideTime (boolean)
hideCalendar (boolean)
format (string)

Custom Editors​

If you want to build a custom property editor for advanced use cases, you can do that with our registerPropertyEditor API.