Skip to content

Commit 2653607

Browse files
Add openModal and closeModal doc (windmill-labs#288)
1 parent d48e061 commit 2653607

File tree

1 file changed

+53
-11
lines changed

1 file changed

+53
-11
lines changed

docs/apps/3_app-runnable-panel.mdx

Lines changed: 53 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,24 +51,24 @@ Background runnables are scripts that are executed in the background. They are n
5151
Evals are used to [connect data sources](./2_outputs.md#connecting-inputs) to other components or parameters.
5252

5353
<video
54-
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
55-
autoPlay
56-
loop
57-
controls
58-
src="/videos/app-connections.mp4"
54+
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
55+
autoPlay
56+
loop
57+
controls
58+
src="/videos/app-connections.mp4"
5959
/>
60-
<br/>
60+
<br />
6161

6262
Windmill parses your eval and frontend scripts using the swc parser compiled to wasm to extract any references to outputs.
63-
It allows Windmill to suggest dependencies for frontend scripts.
63+
It allows Windmill to suggest dependencies for frontend scripts.
6464

6565
<video
66-
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
67-
controls
68-
src="/videos/eval_1.mp4"
66+
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
67+
controls
68+
src="/videos/eval_1.mp4"
6969
/>
7070

71-
<br/>
71+
<br />
7272

7373
Evals are only evaluated on changes to the outputs that have been identified.
7474

@@ -185,6 +185,48 @@ The index of the tab to set.
185185
setTab('a', '1');
186186
```
187187

188+
### openModal
189+
190+
Use the `openModal` function to open a modal.
191+
192+
#### Syntax
193+
194+
```js
195+
openModal(id: string)
196+
```
197+
198+
#### Parameters
199+
200+
`id` string
201+
The id of the modal component to open.
202+
203+
#### Example
204+
205+
```js
206+
openModal('a');
207+
```
208+
209+
### closeModal
210+
211+
Use the `closeModal` function to close a modal.
212+
213+
#### Syntax
214+
215+
```js
216+
closeModal(id: string)
217+
```
218+
219+
#### Parameters
220+
221+
`id` string
222+
The id of the modal component to close.
223+
224+
#### Example
225+
226+
```js
227+
closeModal('a');
228+
```
229+
188230
### recompute
189231

190232
Use the `recompute` function to recompute a component.

0 commit comments

Comments
 (0)