38 lines
738 B
Markdown
38 lines
738 B
Markdown
|
# Action docs
|
||
|
|
Following actions are available inside code editor in appsmith:
|
||
|
|
api.run()
|
||
|
|
query.run()
|
||
|
|
showModal()
|
||
|
|
closeModal()
|
||
|
|
showAlert()
|
||
|
|
storeValue()
|
||
|
|
download()
|
||
|
|
navigateTo()
|
||
|
|
|
||
|
|
Steps to contribute:
|
||
|
|
1. Create a appsmith-docs/actions/<action>.md file.
|
||
|
|
2. Follow the [asset-upload](./asset-upload.md) guidelines to upload and use an asset in docs.
|
||
|
|
|
||
|
|
## Action docs template
|
||
|
|
Copy paste this template
|
||
|
|
```
|
||
|
|
---
|
||
|
|
description: >-
|
||
|
|
Action Description
|
||
|
|
---
|
||
|
|
|
||
|
|
# ActionName
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
| Param | Description |
|
||
|
|
| :--------- | :----------------- |
|
||
|
|
| **param1** | param1 description |
|
||
|
|
| **param2** | param2 description |
|
||
|
|
| **param3** | param3 description |
|
||
|
|
|
||
|
|
## Image/gif of the widget and the icon in widget creation sidebar.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
```
|
||
|
|
|