In addition to the standard notifications, you can show the user a notification with a progress bar.
This method creates a notification with an initial progress bar of zero.
These notifications are stored in the user's local storage, so it can be lost if the browser/session changes.
Notifications can also be associated with your external process via the
externalTaskId parameter - the ID of your task,
which the notification describes.Platforms
- B2B-Web
Method params
| Parameter name | Parameter type | Required | Parameter description |
|---|---|---|---|
| message | string | yes | Notification header. For example: "Uploading data". |
| description | string | no | The body of the notification, which should describe the details of the notification |
| externalTaskId | string | no | The ID of your task that this notification describes. Useful for syncing when a user logs out / logs in to the mini-application |
You can also update these values later with the CondoWebAppUpdateProgressBar method
Return value
If successful, the method will return a JSON object containing a single field
barId - the ID of the created progress bar:json{ "barId": "3f4714ab-30f9-4bd4-b91b-67e9c5b7f1a8" }
Usage example
typescriptimport bridge from '@open-condo/bridge' bridge.send('CondoWebAppShowProgressBar', { message: 'Uploading some data', description: 'Please keep the page open', externalTaskId: '26abf417-9159-488d-a446-595e987d8802', }).then((data) => { console.log(data.barId) })
