Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add openModal and closeModal doc #288

Merged
merged 1 commit into from
Sep 1, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 53 additions & 11 deletions docs/apps/3_app-runnable-panel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,24 +51,24 @@ Background runnables are scripts that are executed in the background. They are n
Evals are used to [connect data sources](./2_outputs.md#connecting-inputs) to other components or parameters.

<video
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
autoPlay
loop
controls
src="/videos/app-connections.mp4"
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
autoPlay
loop
controls
src="/videos/app-connections.mp4"
/>
<br/>
<br />

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

<video
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
controls
src="/videos/eval_1.mp4"
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
controls
src="/videos/eval_1.mp4"
/>

<br/>
<br />

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

Expand Down Expand Up @@ -185,6 +185,48 @@ The index of the tab to set.
setTab('a', '1');
```

### openModal

Use the `openModal` function to open a modal.

#### Syntax

```js
openModal(id: string)
```

#### Parameters

`id` string
The id of the modal component to open.

#### Example

```js
openModal('a');
```

### closeModal

Use the `closeModal` function to close a modal.

#### Syntax

```js
closeModal(id: string)
```

#### Parameters

`id` string
The id of the modal component to close.

#### Example

```js
closeModal('a');
```

### recompute

Use the `recompute` function to recompute a component.
Expand Down