mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-22 14:07:26 +00:00
28 lines
1,010 B
Markdown
28 lines
1,010 B
Markdown
|
---
|
||
|
|
id: creating-widget
|
||
|
|
title: Creating Widgets
|
||
|
|
---
|
||
|
|
|
||
|
|
# Creating Widgets
|
||
|
|
|
||
|
|
These are some of the most useful properties and functions passed to the widget
|
||
|
|
|
||
|
|
### properties
|
||
|
|
|
||
|
|
The `properties` object will contain the configurable properties of a widget, initially obtained from its definition on `widgetConfig.js`.
|
||
|
|
The values inside `properties` change whenever the developer makes changes to the inspector panel of ToolJet editor.
|
||
|
|
|
||
|
|
### exposedVariables
|
||
|
|
|
||
|
|
The `exposedVariables` object will contain the values of all exposed variables as configured in `widgetConfig.js`.
|
||
|
|
|
||
|
|
### setExposedVariable('exposedVariableName', newValue)
|
||
|
|
|
||
|
|
This function allows you to update the value of an exposed variable to `newValue`.
|
||
|
|
|
||
|
|
### validate(value)
|
||
|
|
|
||
|
|
This function validates the `value` passed based on the validation settings configured on the inspector panel for the widget.
|
||
|
|
It returns an array `[isValid, validationError]`, which represents respectively, whether the `value` passed is valid,
|
||
|
|
and the error message if there is one.
|