gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2026-02-20 04:34:38 +01:00
Code Issues Actions 15 Packages Projects Releases Wiki Activity

feat(badges/content): option to open API docs

Browse Source
This commit is contained in:
Elian Doran 2026-02-14 11:12:39 +02:00
parent 66ff009b72
commit a739d28563
No known key found for this signature in database
2 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
apps/client/src/widgets/layout/ActiveContentBadges.tsx
View File

@ -5,7 +5,7 @@ import FNote from "../../entities/fnote";
import attributes from "../../services/attributes";
import { t } from "../../services/i18n";
import { openInAppHelpFromUrl } from "../../services/utils";
import { Badge, BadgeWithDropdown } from "../react/Badge";
import { BadgeWithDropdown } from "../react/Badge";
import { FormListItem } from "../react/FormList";
import FormToggle from "../react/FormToggle";
import { useNoteContext, useTriliumEvent } from "../react/hooks";
@ -16,14 +16,21 @@ const activeContentLabels = [ "iconPack" ] as const;
const typeMappings: Record<ActiveContentInfo["type"], {
icon: string;
helpPage: string;
apiDocsPage?: string;
}> = {
iconPack: {
icon: "bx bx-package",
helpPage: "g1mlRoU8CsqC"
helpPage: "g1mlRoU8CsqC",
},
backendScript: {
icon: "bx bx-server",
helpPage: "SPirpZypehBG"
helpPage: "SPirpZypehBG",
apiDocsPage: "MEtfsqa5VwNi"
},
frontendScript: {
icon: "bx bx-window",
helpPage: "yIhgI5H7A2Sm",
apiDocsPage: "Q2z6av6JZVWm"
}
};
@ -40,7 +47,7 @@ export function ActiveContentBadges() {
}
function ActiveContentBadge({ info }: { note: FNote, info: ActiveContentInfo }) {
const { icon, helpPage } = typeMappings[info.type];
const { icon, helpPage, apiDocsPage } = typeMappings[info.type];
return (
<BadgeWithDropdown
className="icon-pack-badge"
@ -51,6 +58,11 @@ function ActiveContentBadge({ info }: { note: FNote, info: ActiveContentInfo })
icon="bx bx-help-circle"
onClick={() => openInAppHelpFromUrl(helpPage)}
>{t("active_content_badges.menu_docs")}</FormListItem>
{apiDocsPage && <FormListItem
icon="bx bx-book-content"
onClick={() => openInAppHelpFromUrl(apiDocsPage)}
>{t("code_buttons.trilium_api_docs_button_title")}</FormListItem>}
</BadgeWithDropdown>
);
}
@ -98,7 +110,7 @@ function getNameWithoutPrefix(name: string) {
}
interface ActiveContentInfo {
type: "iconPack" | "backendScript";
type: "iconPack" | "backendScript" | "frontendScript";
isEnabled: boolean;
}

10
apps/client/src/widgets/ribbon/NoteActionsCustom.tsx
View File

@ -70,7 +70,6 @@ export default function NoteActionsCustom(props: NoteActionsCustomProps) {
>
<AddChildButton {...innerProps} />
<RunActiveNoteButton {...innerProps } />
<OpenTriliumApiDocsButton {...innerProps} />
<SwitchSplitOrientationButton {...innerProps} />
<ToggleReadOnlyButton {...innerProps} />
<SaveToNoteButton {...innerProps} />
@ -230,15 +229,6 @@ function SaveToNoteButton({ note, noteMime }: NoteActionsCustomInnerProps) {
/>;
}
function OpenTriliumApiDocsButton({ noteMime }: NoteActionsCustomInnerProps) {
const isEnabled = noteMime.startsWith("application/javascript;env=");
return isEnabled && <NoteAction
icon="bx bx-help-circle"
text={t("code_buttons.trilium_api_docs_button_title")}
onClick={() => openInAppHelpFromUrl(noteMime.endsWith("frontend") ? "Q2z6av6JZVWm" : "MEtfsqa5VwNi")}
/>;
}
function InAppHelpButton({ note }: NoteActionsCustomInnerProps) {
const helpUrl = getHelpUrlForNote(note);
const isEnabled = !!helpUrl;