Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-13 08:45:50 +01:00
Code Issues Packages Projects Releases Activity

Fix and improve JSDoc for APIs

Browse Source
This commit is contained in:
Zack Rauen
2023-08-21 04:15:53 -04:00
parent b5ef09e779
commit d3730ac1a9
12 changed files with 238 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/public/app/widgets/note_context_aware_widget.js
View File

@@ -1,7 +1,11 @@
import BasicWidget from "./basic_widget.js";
import appContext from "../components/app_context.js";
export default class NoteContextAwareWidget extends BasicWidget {
/**
* This widget allows for changing and updating depending on the active note.
* @extends {BasicWidget}
*/
class NoteContextAwareWidget extends BasicWidget {
isNoteContext(ntxId) {
if (Array.isArray(ntxId)) {
return this.noteContext && ntxId.includes(this.noteContext.ntxId);
@@ -43,6 +47,9 @@ export default class NoteContextAwareWidget extends BasicWidget {
return this.noteContext?.ntxId;
}
/**
* @returns {boolean} true when an active note exists
*/
isEnabled() {
return !!this.note;
}
@@ -58,6 +65,8 @@ export default class NoteContextAwareWidget extends BasicWidget {
}
/**
* Override this method to be able to refresh your
* widget with each note.
* @param {FNote} note
* @returns {Promise<void>}
*/
@@ -109,3 +118,5 @@ export default class NoteContextAwareWidget extends BasicWidget {
await this.refresh();
}
}
export default NoteContextAwareWidget;