Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-12-19 22:59:53 +01:00
Code Issues Packages Projects Releases Activity

docs(script): clarify originEntity and activeContext

Browse Source
This commit is contained in:
Elian Doran
2025-12-07 23:58:02 +02:00
parent 2f13a1ad21
commit cb3aced2ed
5 changed files with 206 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
apps/client/src/services/frontend_script_api.ts
View File

@@ -77,6 +77,10 @@ export interface Api {
/**
* Entity whose event triggered this execution.
*
* <p>
* For front-end scripts, generally there's no origin entity specified since the scripts are run by the user or automatically by the UI (widgets).
* If there is an origin entity specified, then it's going to be a note entity.
*/
originEntity: unknown | null;
@@ -278,12 +282,16 @@ export interface Api {
getActiveContextNote(): FNote;
/**
* @returns returns active context (split)
* Obtains the currently active/focused split in the current tab.
*
* Note that this method does not return the note context of the "Quick edit" panel, it will return the note context behind it.
*/
getActiveContext(): NoteContext;
/**
* @returns returns active main context (first split in a tab, represents the tab as a whole)
* Obtains the main context of the current tab. This is the left-most split.
*
* Note that this method does not return the note context of the "Quick edit" panel, it will return the note context behind it.
*/
getActiveMainContext(): NoteContext;