Widgets

widgets are javascript and html components that you can use to enrich the user interface (ui) of records they allow you to create your own ui components that interact with swimlane or third party endpoints currently, swimlane supports two types of widgets record widgets and report widgets this topic covers record widgets for more about using widgets for reports, see report widgets docid\ xtky4ve1ccb2lkailowc5 to create record widgets from the layout section of the application builder or applet builder page, select widgets , and then drag and drop it into the form layout you can add multiple widgets per application or applet to edit the record widget, select the widget in the form layout, and then, from the field properties click edit widget record widgets are rendered on the record page and have access to the record values through the record attribute every change to the record will automatically update the widget, by calling its update method the record attribute is a javascript object, where the keys are the field's key property, and the value is the field value for that record example if you had an application that has a text field with the key text and a numeric field with the key numeric , the record object would look like this { text 'text field value', numeric 55 } this object can be used in the widget's update method to generate the updated html of the widget after a change to the record widgets do not save or retain any data and are used only to build a ui component that interacts with other data on the record store record data in a visible or hidden field on the record when you export an application or applet that contains a widget, the widget is exported too this allows you to easily share and reuse widgets the widget's code is included in the exported application since the widget's code is also included in the exported application or applet json file, swimlane recommends that you do not include any sensitive information in widgets