Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-29 17:26:38 +01:00
Code Issues Packages Projects Releases Activity

docs(user): use webviews for frontend & backend APIs

Browse Source
This commit is contained in:
Elian Doran
2025-04-13 19:09:14 +03:00
parent 002140c998
commit 31fb7c1404
10 changed files with 105 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/User Guide/User Guide/Scripting/Script API.md
View File

@@ -1,7 +1,19 @@
# Script API
Trilium offers a "Script API" that enables scripts to perform various useful functions. There are two main APIs available:
For [script code notes](../Scripting.md), Trilium offers an API that gives them access to various features of the application.
* [Frontend API](https://triliumnext.github.io/Notes/frontend_api/FrontendScriptApi.html)
* [Backend API](https://triliumnext.github.io/Notes/backend_api/BackendScriptApi.html)
There are two APIs:
Please note that the Script API is currently experimental and may undergo changes in future updates.
* One for the front-end scripts: <a class="reference-link" href="Script%20API/Frontend%20API">Frontend API</a>
* One for the back-end scripts: <a class="reference-link" href="Script%20API/Backend%20API.dat">Backend API</a>
In both cases, the API resides in a global variable, `api`, that can be used anywhere in the script.
For example, to display a message to the user the following front-end script can be used:
```
api.showMessage("Hello world.");
```
> [!NOTE]
> **Note**
> The Script API is currently experimental and may undergo changes in future updates.