Home
Reference
The documents in this section provide reference material and samples for Domino Leap.
Custom Widget API
This API provides a mechanism to incorporate custom widgets into the HCL Domino Leap product.
Built-In Properties
Some properties that already exist in the product are general purpose, or, are integral to the proper functioning of a widget.

Reference
The documents in this section provide reference material and samples for Domino Leap.
- REST API reference
  The REST API can be used by other programs to communicate with Domino Leap.
- JavaScript™ API
- Services
  The following topics provide reference information about adding services to Domino Leap.
- Embedding items in an iframe
  You can use iFrames to embed charts and applications in a web page.
- Embedding API
  The Embedding API is used to embed a Domino Leap form directly in another webpage without using an <iframe>. The Domino Leap form is inserted into the DOM of the hosting page and can be interacted with using the JavaScript API or any custom JavaScript. Additionally, the style of items in the 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 Domino 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 Domino 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 Domino Leap to interact with the instantiated widget.
  - Aggregation Widgets
    A custom widget with a datatype of aggregation is a special type of data widget that can achieve the use-case of a repeating section.
  - 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 Domino 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

Built-In Properties

Some properties that already exist in the product are general purpose, or, are integral to the proper functioning of a widget.

The following built-in properties are supported for custom widgets:

'required': For data widgets, allows the app author to ensure that a value is collected. Whether it is required will be enforced beyond the UI; the integrity of the data will be enforced when it is submitted to the server.
'title': This is used in various contexts to allow for editing and display of the name of a widget instance.
'seenInOverview': allows the app author to decide if the widget's data should be displayed in the View Data page.
'range': This will add a Range with Min and Max properties to the property panel and allow an app author to specify min and max value. This property can be used with widgets with datatype of number, time, date and timestamp.
'format': This will add a Format property to the property panel and allow an app author to specify a format for the string. This property can be used by widgets with datatype of string only.

Example:

const myWidgetDefinition = {
    ...
    builtInProperties : [{ id: 'required'}, {id: 'title'}, {id: 'seenInOverview', defaultValue: true}],
    ...
}

Note: All widgets will be implicitly given an ID property. The default value of this property will be auto-incrementing unique value based on the last substring of the widget definition's id. For example, a widget with an id of 'example.YesNo' will result in a default ID of 'F_YesNo1'. Similar to Leap's built-in widgets, the app author is free to alter the ID to suit their needs.