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

refactor(react/note_title): use note property for title as well

Browse Source
This commit is contained in:
Elian Doran
2025-08-21 10:53:59 +03:00
parent db2bf537ea
commit 4da3e8a4d8
2 changed files with 24 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
apps/client/src/widgets/react/hooks.tsx
View File

@@ -264,17 +264,30 @@ export function useNoteContext() {
}
export function useNoteProperty<T extends keyof FNote>(note: FNote | null | undefined, property: T) {
/**
* Allows a React component to listen to obtain a property of a {@link FNote} while also automatically watching for changes, either via the user changing to a different note or the property being changed externally.
*
* @param note the {@link FNote} whose property to obtain.
* @param property a property of a {@link FNote} to obtain the value from (e.g. `title`, `isProtected`).
* @param componentId optionally, constricts the refresh of the value if an update occurs externally via the component ID of a legacy widget. This can be used to avoid external data replacing fresher, user-inputted data.
* @returns the value of the requested property.
*/
export function useNoteProperty<T extends keyof FNote>(note: FNote | null | undefined, property: T, componentId?: string) {
if (!note) {
return null;
}
const [ value, setValue ] = useState<FNote[T]>(note[property]);
useEffect(() => setValue(value), [ note[property] ]);
// Watch for note changes.
useEffect(() => setValue(note[property]), [ note[property] ]);
// Watch for external changes.
useTriliumEventBeta("entitiesReloaded", ({ loadResults }) => {
if (loadResults.isNoteReloaded(note.noteId)) {
if (loadResults.isNoteReloaded(note.noteId, componentId)) {
setValue(note[property]);
}
});
return value;
}