feat(in-app-help): contextual help button for geo notes

This commit is contained in:
Elian Doran 2025-02-02 20:44:36 +02:00
parent 64654290be
commit 868ca2d982
No known key found for this signature in database
3 changed files with 67 additions and 0 deletions

View File

@ -86,6 +86,7 @@ import ClassicEditorToolbar from "../widgets/ribbon_widgets/classic_editor_toolb
import options from "../services/options.js";
import utils from "../services/utils.js";
import GeoMapButtons from "../widgets/floating_buttons/geo_map_button.js";
import ContextualHelpButton from "../widgets/floating_buttons/help_button.js";
export default class DesktopLayout {
constructor(customWidgets) {
@ -205,6 +206,7 @@ export default class DesktopLayout {
.child(new CopyImageReferenceButton())
.child(new SvgExportButton())
.child(new BacklinksWidget())
.child(new ContextualHelpButton())
.child(new HideFloatingButtonsButton())
)
.child(new MermaidWidget())

View File

@ -0,0 +1,62 @@
import appContext from "../../components/app_context.js";
import type { NoteType } from "../../entities/fnote.js";
import { t } from "../../services/i18n.js";
import NoteContextAwareWidget from "../note_context_aware_widget.js";
const TPL = `
<button class="open-contextual-help-button" title="${t("help-button.title")}">
<span class="bx bx-help-circle"></span>
</button>
`;
const byNoteType: Record<NoteType, string | null> = {
book: null,
canvas: null,
code: null,
contentWidget: null,
doc: null,
file: null,
geoMap: "foPEtsL51pD2",
image: null,
launcher: null,
mermaid: null,
mindMap: null,
noteMap: null,
relationMap: null,
render: null,
search: null,
text: null,
webView: null
};
export default class ContextualHelpButton extends NoteContextAwareWidget {
private helpNoteIdToOpen?: string | null;
isEnabled() {
this.helpNoteIdToOpen = null;
if (!super.isEnabled()) {
return false;
}
if (this.note && byNoteType[this.note.type]) {
this.helpNoteIdToOpen = byNoteType[this.note.type];
}
return !!this.helpNoteIdToOpen;
}
doRender() {
this.$widget = $(TPL);
this.$widget.on("click", () => {
const subContexts = appContext.tabManager.getActiveContext().getSubContexts();
const { ntxId } = subContexts[subContexts.length - 1];
this.triggerCommand("openNewNoteSplit", {
ntxId,
notePath: `_help_${this.helpNoteIdToOpen}`
})
});
}
}

View File

@ -1644,5 +1644,8 @@
"geo-map-context": {
"open-location": "Open location",
"remove-from-map": "Remove from map"
},
"help-button": {
"title": "Open the relevant help page"
}
}