Skip to content

Commit 1b99a83

Browse files
committed
Review:
* Add prerequisites section instead of just mentioning the menu api familiarity in a sentence below * Move the wrongly committed part of the introduction from dialogs-api.md to the progress-dialogs.md
1 parent 250f856 commit 1b99a83

2 files changed

Lines changed: 12 additions & 5 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/dialog-api.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ url: /apidocs-mxsdk/apidocs/web-extensibility-api-11/dialog-api/
88

99
This how-to describes how to open a modal dialog in Studio Pro from an extension, allowing you to display web content.
1010

11-
It also covers how to show a progress dialog that follows a sequence of steps and returns a result upon completion.
12-
1311
## Prerequisites
1412

1513
This how-to uses the results of [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/). Please complete that how-to before starting this one. You should also be familiar with creating menus as described in [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/progress-dialogs.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,19 @@ title: "Show a Progress Dialog Using Web API"
33
linktitle: "Show a Progress Dialog"
44
url: /apidocs-mxsdk/apidocs/web-extensibility-api-11/progress-dialogs/
55
---
6+
7+
## Introduction
8+
9+
This how-to describes how to show a progress dialog that follows a sequence of steps and returns a result upon completion.
10+
11+
## Prerequisites
12+
13+
Before starting this how-to, ensure you have:
14+
15+
1. Completed the steps in [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/).
16+
2. Become familiar with creating menus as described in [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
617

718
## Showing a Progress Dialog
8-
First, create a menu that you will use to open the progress dialog.
9-
1019
To show a progress dialog, you will need to call the method `studioPro.ui.dialogs.showProgressDialog(<title>, <steps>)`, where:
1120

1221
* `<title>` is a string which will be displayed in the title bar of the dialog.
@@ -28,7 +37,7 @@ The `FailedProgressStepResult` object contains the following properties:
2837
* `stepTitle` - the title of the step that has failed, causing the whole process to fail
2938
* `error` - a string which describes the error or exception that has occurred during the step execution
3039

31-
In this example, we will create a menu to show the modal progress dialog, and run three steps. This is done inside the `loaded` event in the main entry point (`src/main/index.ts`). For more information, see [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
40+
In this example, we will create a menu to show the modal progress dialog, and run three steps. This is done inside the `loaded` event in the main entry point (`src/main/index.ts`).
3241

3342
```typescript
3443
import { ComponentContext, IComponent, ProgressDialogStep, getStudioProApi } from "@mendix/extensions-api";

0 commit comments

Comments
 (0)