Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-10-06 05:02:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(client/ts): port note_context_aware_widget

Browse Source
This commit is contained in:
Elian Doran 2025-01-07 11:55:20 +02:00
parent f3a18a9942
commit 0713b4aec8
No known key found for this signature in database
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/public/app/widgets/note_context_aware_widget.js → src/public/app/widgets/note_context_aware_widget.ts
View File

@ -1,12 +1,17 @@
import BasicWidget from "./basic_widget.js"; import BasicWidget from "./basic_widget.js";
import appContext from "../components/app_context.js"; import appContext, { EventData } from "../components/app_context.js";
import FNote from "../entities/fnote.js";
import NoteContext from "../components/note_context.js";
/** /**
* This widget allows for changing and updating depending on the active note. * This widget allows for changing and updating depending on the active note.
* @extends {BasicWidget} * @extends {BasicWidget}
*/ */
class NoteContextAwareWidget extends BasicWidget { class NoteContextAwareWidget extends BasicWidget {
isNoteContext(ntxId) {
private noteContext?: NoteContext;
isNoteContext(ntxId: string) {
if (Array.isArray(ntxId)) { if (Array.isArray(ntxId)) {
return this.noteContext && ntxId.includes(this.noteContext.ntxId); return this.noteContext && ntxId.includes(this.noteContext.ntxId);
} }
@ -19,26 +24,22 @@ class NoteContextAwareWidget extends BasicWidget {
return appContext.tabManager.getActiveContext() === this.noteContext; return appContext.tabManager.getActiveContext() === this.noteContext;
} }
isNote(noteId) { isNote(noteId: string) {
return this.noteId === noteId; return this.noteId === noteId;
} }
/** @returns {FNote|undefined} */
get note() { get note() {
return this.noteContext?.note; return this.noteContext?.note;
} }
/** @returns {string|undefined} */
get noteId() { get noteId() {
return this.note?.noteId; return this.note?.noteId;
} }
/** @returns {string|undefined} */
get notePath() { get notePath() {
return this.noteContext?.notePath; return this.noteContext?.notePath;
} }
/** @returns {string} */
get hoistedNoteId() { get hoistedNoteId() {
return this.noteContext?.hoistedNoteId; return this.noteContext?.hoistedNoteId;
} }
@ -53,7 +54,7 @@ class NoteContextAwareWidget extends BasicWidget {
* <p> * <p>
* If the widget is not enabled, it will not receive `refreshWithNote` updates. * If the widget is not enabled, it will not receive `refreshWithNote` updates.
* *
* @returns {boolean} true when an active note exists * @returns true when an active note exists
*/ */
isEnabled() { isEnabled() {
return !!this.note; return !!this.note;
@ -80,14 +81,11 @@ class NoteContextAwareWidget extends BasicWidget {
} }
/** /**
* Override this method to be able to refresh your * Override this method to be able to refresh your widget with each note.
* widget with each note.
* @param {FNote} note
* @returns {Promise<void>}
*/ */
async refreshWithNote(note) {} async refreshWithNote(note: FNote | null | undefined) {}
async noteSwitchedEvent({noteContext, notePath}) { async noteSwitchedEvent({noteContext, notePath}: EventData<"noteSwitched">) {
this.noteContext = noteContext; this.noteContext = noteContext;
// if notePath does not match, then the noteContext has been switched to another note in the meantime // if notePath does not match, then the noteContext has been switched to another note in the meantime
if (noteContext.notePath === notePath) { if (noteContext.notePath === notePath) {
@ -99,7 +97,7 @@ class NoteContextAwareWidget extends BasicWidget {
await this.refresh(); await this.refresh();
} }
async activeContextChangedEvent({noteContext}) { async activeContextChangedEvent({noteContext}: EventData<"activeContextChanged">) {
this.noteContext = noteContext; this.noteContext = noteContext;
await this.activeContextChanged(); await this.activeContextChanged();
@ -110,7 +108,7 @@ class NoteContextAwareWidget extends BasicWidget {
} }
// when note is both switched and activated, this should not produce a double refresh // when note is both switched and activated, this should not produce a double refresh
async noteSwitchedAndActivatedEvent({noteContext, notePath}) { async noteSwitchedAndActivatedEvent({noteContext, notePath}: EventData<"noteSwitchedAndActivatedEvent">) {
this.noteContext = noteContext; this.noteContext = noteContext;
// if notePath does not match, then the noteContext has been switched to another note in the meantime // if notePath does not match, then the noteContext has been switched to another note in the meantime
@ -119,12 +117,12 @@ class NoteContextAwareWidget extends BasicWidget {
} }
} }
setNoteContextEvent({noteContext}) { setNoteContextEvent({noteContext}: EventData<"setNoteContext">) {
/** @var {NoteContext} */ /** @var {NoteContext} */
this.noteContext = noteContext; this.noteContext = noteContext;
} }
async noteTypeMimeChangedEvent({noteId}) { async noteTypeMimeChangedEvent({noteId}: EventData<"noteTypeMimeChangedEvent">) {
if (this.isNote(noteId)) { if (this.isNote(noteId)) {
await this.refresh(); await this.refresh();
} }