Home
Reference
The documents in this section provide reference material and samples for HCL Leap .
Custom Widget API
This API provides a mechanism to incorporate custom widgets into the HCL Leap product.
Validation
Some intrinsic validation will be done according to the type and constraints declared in the widget's datatype property; however, it might be necessary for a widget to supply its own custom validation logic.

Reference
The documents in this section provide reference material and samples for HCL Leap .
- REST API reference
  The REST API can be used by other programs to communicate with Leap.
- JavaScript™ API
- Services
  The following topics provide reference information about adding services to HCL Leap .
- Embedding items in an iframe
  You can use iFrames to embed charts and applications in a web page.
- Embedding API
  The Embedding API can be used to embed a Leap form directly in another webpage without using an <iframe>. The Leap form will be inserted into the DOM of the hosting page and can be interacted with using the Leap JavaScript API or any custom JavaScript. Additionally, the style of items in the Leap form can be customized by the CSS of the hosting page.
- Creating customized Cascading Style Sheets
  You can apply your own custom Cascading Style Sheet (CSS) to the rendering of your HCL Leap application. To create a custom theme, you must be familiar with the basic concepts of CSS.
- Custom Widget API
  This API provides a mechanism to incorporate custom widgets into the HCL Leap product.
  - Data Widgets vs Display Widgets
    Some widgets are for collecting data (ie. "data widgets") and others are presentational in nature (ie. "display widgets").
  - Data Types
    Data widgets can declare one of the listed data types, each with additional optional constraints.
  - Rules
    App authors will be able to incorporate custom widgets in rules.
  - Built-In Properties
    Some properties that already exist in the product are general purpose, or, are integral to the proper functioning of a widget.
  - Custom Properties
    The custom widget can define an array of custom properties for the app author to modify.
  - Widgets with Options
    Widgets that allow the end-user to select from a set of options require specific treatment. This includes widgets such as dropdowns, radio groups, or checkbox groups. These options could be hardcoded in the custom widget, or defined by the app author.
  - Widget Instantiation
    The widget instantiate() function is called when an instance of the custom widget needs to be created. The function is expected to return an object that allows Leap to interact with the instantiated widget.
  - Validation
    Some intrinsic validation will be done according to the type and constraints declared in the widget's datatype property; however, it might be necessary for a widget to supply its own custom validation logic.
  - Internationalization
    Certain attributes of the widget definition can be displayed to app authors working in different locales. To support multiple languages during authoring, some properties can be specified as "multi-string" objects rather than a plain string values.
  - Usage of JavaScript API
    Custom widgets can use Leap's JavaScript API to help achieve their objectives.
  - Versioning
    This topic describes the widget's version.
  - Upgrading
    The exact techniques for upgrading widgets from one major version to the next has not yet been established.
  - Security Considerations
    This topic describes security considerations for Custom Widget API.
  - Incorporating third-party libraries
    This topic describes incorporating third-party libraries.
  - Known limitations
  - Examples

Validation

Some intrinsic validation will be done according to the type and constraints declared in the widget's datatype property; however, it might be necessary for a widget to supply its own custom validation logic.

This can be done by supplying a validateValue() function, which returns one of the following values:

null : indicates the value is valid
An error message : the returned error message will be displayed to the app user in some contexts (ex. when attempting to go the next page).

It is responsibility of the custom widget to render itself appropriately based on its state of validity.

Note: The widget's setErrorMessage function will be triggered whenever the validity changes, due to contraints on the datatype or custom validation from the validateValue() function.

Note: Any additional validation provided by the custom widget via a validateValue() function will not be enforced on the server; however, it will prevent the form from being submitted by the user in the browser.