JavaScript API

📄️ Data

Data is the object that provides read access to the form values data.

📄️ API for saving files

fileSaver object provides a function that can be used to save files to the backend. The function takes the following parameters:

📄️ Form instance API

form object provides access to the form instance. It has object and function properties that can be used to interact with the form.

HTTP is the object that provides access to the HTTP API that can be used to make HTTP requests. HTTP Requests are the lifeblood of a Shesha application. In order for the application to function well, the front-end needs to send data to the backend, for that data to be saved in the database. This is where HTTP requests come in. The Shesha front-end uses axios under the hood, and an axios instance is exposed on almost all the available Scripts on the configurator. For more on Shesha Scripts, see here.

📄️ Shesha JavaScript API Plugins

Shesha allows developers to extend the application JS API using useApplicationPlugin hook. Example of usage provided below:

📄️ Loader API

The Shesha loader provides a full-page spinner overlay that you can trigger from form scripts, custom actions, and data context expressions. It is designed for async operations where you want to give the user visual feedback.

📄️ Message

The message object provides access to the message API that can be used to display messages to the user.

📄️ Modal API

The modal object provides methods for displaying various types of dialogs and modals to the user. This API is built on top of Ant Design's Modal component and provides Promise-based methods for handling user interactions.

📄️ Moment

Moment is the object that provides access to the moment API.