Skip to content

Build your personal knowledge base with Trilium Notes

client/text editor/youtube preview: wait for the embed to be ready before dismissing the popover

Adorian Doran356c255bd55d
diff --git a/.claude/skills/developing-content-embeds/SKILL.md b/.claude/skills/developing-content-embeds/SKILL.md
index 3c5753a37d..bf61260c6d 100644
--- a/.claude/skills/developing-content-embeds/SKILL.md
+++ b/.claude/skills/developing-content-embeds/SKILL.md
@@ -85,7 +85,10 @@ All three carry `boxSize`, `hideTitle`, `editable`, `displayMode` (`data-box-siz
frame in an embed that a window `blur` leaves focused, and `blur` on the next window `focus`;
the embed's own `focus` listener and `FocusTracker` do the rest.
`createLinkPreview()` in `link_embed_commands.ts` is the one place that picks `linkMention`,
- `linkEmbed` or a video embed for a display mode.
+ `linkEmbed` or a video embed for a display mode. The YouTube video prompt (`youtube_video.ts`)
+ inserts the player only once `fetchMetadata()` has returned, with no link meanwhile: its
+ `onInsert()` rejects on unresolved metadata, and the host's prompt keeps Insert disabled while
+ it waits and shows an error toast when it rejects.
- **Legacy blocks** — a `<pre>` without `data-box-size` predates the embed (the old Mermaid
plugin). `getModeOfSavedView()` loads it editable, in the view of its
`data-trilium-display-mode` or split, at Medium. A saved embed keeps exactly what it has.
diff --git a/apps/client/src/translations/en/translation.json b/apps/client/src/translations/en/translation.json
index 5ec1e75538..4dc6c85343 100644
--- a/apps/client/src/translations/en/translation.json
+++ b/apps/client/src/translations/en/translation.json
@@ -5029,6 +5029,7 @@
"youtube_video": {
"title": "Insert YouTube video",
"button_insert": "Insert video",
- "not_a_video": "This is not the address of a YouTube video."
+ "not_a_video": "This is not the address of a YouTube video.",
+ "insert_failed": "The video could not be loaded. Check the address and the connection, then try again."
}
}
diff --git a/apps/client/src/widgets/dialogs/youtube_video.spec.tsx b/apps/client/src/widgets/dialogs/youtube_video.spec.tsx
index d02e3b0d98..c37a229755 100644
--- a/apps/client/src/widgets/dialogs/youtube_video.spec.tsx
+++ b/apps/client/src/widgets/dialogs/youtube_video.spec.tsx
@@ -1,12 +1,24 @@
+import { Modal as BootstrapModal } from "bootstrap";
import { act } from "preact/test-utils";
-import { beforeEach, describe, expect, it, vi } from "vitest";
+import { beforeEach, describe, expect, it, type Mock, vi } from "vitest";
import Component from "../../components/component";
import { renderInto } from "../../test/render";
import { ParentComponent } from "../react/react_utils";
import YouTubeVideoDialog, { getYouTubeVideoUrl, YouTubeVideoBalloon } from "./youtube_video";
+const { showError } = vi.hoisted(() => ({ showError: vi.fn() }));
+
vi.mock("../../services/i18n", () => ({ t: (key: string) => key }));
+vi.mock("../../services/toast", () => ({ default: { showError } }));
+// Raises the modal at once, so that it has the Bootstrap instance it closes through.
+vi.mock("../../services/dialog", () => ({
+ openDialog: async (dialog: JQuery<HTMLElement>) => dialog
+}));
+
+beforeEach(() => {
+ vi.spyOn(console, "error").mockImplementation(() => {});
+});
const VIDEO_URL = "https://www.youtube.com/watch?v=dQw4w9WgXcQ";
@@ -28,10 +40,36 @@ describe("getYouTubeVideoUrl", () => {
});
describe("YouTubeVideoBalloon", () => {
- const onInsert = vi.fn();
+ const onInsert = vi.fn(async (_url: string) => {});
beforeEach(() => {
vi.clearAllMocks();
+ onInsert.mockReset();
+ });
+
+ it("disables Insert while the video loads, and shows a toast when it fails", async () => {
+ const insertion = deferInsertion(onInsert);
+ let container = document.body;
+ await act(async () => {
+ container = renderInto(<YouTubeVideoBalloon onInsert={onInsert} />);
+ });
+ const form = container.querySelector("form");
+ if (!form) throw new Error("The balloon has no form.");
+ await type(container.querySelector(".youtube-video-url input"), VIDEO_URL);
+
+ await submit(form);
+ expect(insertButton(container)?.disabled).toBe(true);
+ await submit(form);
+ expect(onInsert).toHaveBeenCalledExactlyOnceWith(VIDEO_URL);
+
+ await insertion.fail();
+ expect(showError).toHaveBeenCalledExactlyOnceWith("youtube_video.insert_failed");
+ expect(insertButton(container)?.disabled).toBe(false);
+
+ await submit(form);
+ await insertion.succeed();
+ expect(onInsert).toHaveBeenCalledTimes(2);
+ expect(showError).toHaveBeenCalledOnce();
});
it("focuses the field, and inserts only the address of a video", async () => {
@@ -61,12 +99,14 @@ describe("YouTubeVideoBalloon", () => {
});
describe("YouTubeVideoDialog", () => {
- const onInsert = vi.fn();
+ const onInsert = vi.fn(async (_url: string) => {});
let host: Component;
let container: HTMLElement;
beforeEach(() => {
vi.clearAllMocks();
+ onInsert.mockReset();
+ vi.spyOn(BootstrapModal.prototype, "hide").mockImplementation(() => {});
host = new Component();
container = renderInto(
<ParentComponent.Provider value={host}>
@@ -91,16 +131,27 @@ describe("YouTubeVideoDialog", () => {
});
}
- it("inserts the video once the modal is gone, and opens again on an empty field", async () => {
+ it("closes once the video is inserted, and stays open with a toast when it fails", async () => {
+ const insertion = deferInsertion(onInsert);
await open();
const form = container.querySelector("form");
if (!form) throw new Error("The dialog has no form.");
await type(field(), VIDEO_URL);
await submit(form);
- expect(onInsert).not.toHaveBeenCalled();
- await hide();
expect(onInsert).toHaveBeenCalledExactlyOnceWith(VIDEO_URL);
+ expect(insertButton(container)?.disabled).toBe(true);
+ await insertion.fail();
+ expect(showError).toHaveBeenCalledExactlyOnceWith("youtube_video.insert_failed");
+ expect(insertButton(container)?.disabled).toBe(false);
+ expect(BootstrapModal.prototype.hide).not.toHaveBeenCalled();
+
+ await submit(form);
+ expect(onInsert).toHaveBeenCalledTimes(2);
+ expect(BootstrapModal.prototype.hide).not.toHaveBeenCalled();
+ await insertion.succeed();
+ expect(BootstrapModal.prototype.hide).toHaveBeenCalledOnce();
+ await hide();
await open();
expect(field()?.value).toBe("");
@@ -115,6 +166,25 @@ describe("YouTubeVideoDialog", () => {
});
});
+/**
+ * Makes each call of `onInsert` wait until `succeed()` or `fail()` settles it. Both wait a task,
+ * so that what the component does after the insertion renders before they return.
+ */
+function deferInsertion(onInsert: Mock<(url: string) => Promise<void>>) {
+ let settle: (error?: Error) => void = () => {};
+ onInsert.mockImplementation(() => new Promise<void>((resolve, reject) => {
+ settle = (error) => error ? reject(error) : resolve();
+ }));
+ const settleWith = (error?: Error) => act(async () => {
+ settle(error);
+ await new Promise((resolve) => setTimeout(resolve));
+ });
+ return {
+ succeed: () => settleWith(),
+ fail: () => settleWith(new Error("Offline"))
+ };
+}
+
function insertButton(container: HTMLElement) {
return container.querySelector<HTMLButtonElement>("button[type=submit]");
}
diff --git a/apps/client/src/widgets/dialogs/youtube_video.tsx b/apps/client/src/widgets/dialogs/youtube_video.tsx
index 5f66676c2b..7665070a2d 100644
--- a/apps/client/src/widgets/dialogs/youtube_video.tsx
+++ b/apps/client/src/widgets/dialogs/youtube_video.tsx
@@ -4,6 +4,7 @@ import { extractYouTubeVideoId, isHttpUrl } from "@triliumnext/commons";
import { useEffect, useRef, useState } from "preact/hooks";
import { t } from "../../services/i18n";
+import toast from "../../services/toast";
import Button from "../react/Button";
import { Card, OptionCardSection } from "../react/Card";
import FormTextBox from "../react/FormTextBox";
@@ -12,19 +13,23 @@ import Modal from "../react/Modal";
import { suspendModalFocusTraps } from "../react/modal_focustrap";
export interface YouTubeVideoOpts {
- /** Inserts a player of the YouTube video at `url`. */
- onInsert(url: string): void;
+ /**
+ * Inserts a player of the YouTube video at `url` once it is ready, and rejects when it cannot
+ * be loaded.
+ */
+ onInsert(url: string): Promise<void>;
}
/**
* Asks for the address of a YouTube video in a modal, on the `showYouTubeVideoDialog` event. The
- * text editor uses it on mobile, where it has no room for its balloon.
+ * text editor uses it on mobile, where it has no room for its balloon. The modal closes once the
+ * video is inserted.
*/
export default function YouTubeVideoDialog() {
const [ opts, setOpts ] = useState<YouTubeVideoOpts>();
const [ isShown, setIsShown ] = useState(false);
- const submittedUrlRef = useRef<string | null>(null);
const form = useYouTubeVideoForm();
+ const { isInserting, insert } = useVideoInsertion();
useTriliumEvent("showYouTubeVideoDialog", (newOpts) => {
setOpts(newOpts);
@@ -37,20 +42,15 @@ export default function YouTubeVideoDialog() {
className="youtube-video-dialog"
size="lg"
title={t("youtube_video.title")}
- footer={<InsertButton isEnabled={!!form.url} />}
- onSubmit={() => {
- if (!form.url) return;
+ footer={<InsertButton isEnabled={!!form.url && !isInserting} />}
+ onSubmit={async () => {
+ if (!form.url || !opts || isInserting) return;
- submittedUrlRef.current = form.url;
- setIsShown(false);
- }}
- onHidden={() => {
- // Inserted once the modal is gone, so the editor can take the focus back.
- const url = submittedUrlRef.current;
- submittedUrlRef.current = null;
- setIsShown(false);
- if (url) opts?.onInsert(url);
+ if (await insert(opts.onInsert, form.url)) {
+ setIsShown(false);
+ }
}}
+ onHidden={() => setIsShown(false)}
show={isShown}
>
{form.body}
@@ -58,11 +58,15 @@ export default function YouTubeVideoDialog() {
);
}
-/** The form of the prompt in the balloon that the text editor places at the caret. */
+/**
+ * The form of the prompt in the balloon that the text editor places at the caret, which the editor
+ * closes once the video is inserted.
+ */
export function YouTubeVideoBalloon({ onInsert }: YouTubeVideoOpts) {
// Lets the field take focus inside a modal, such as the quick edit popup.
useEffect(() => suspendModalFocusTraps(), []);
const form = useYouTubeVideoForm();
+ const { isInserting, insert } = useVideoInsertion();
useEffect(() => {
form.inputRef.current?.focus();
@@ -72,17 +76,41 @@ export function YouTubeVideoBalloon({ onInsert }: YouTubeVideoOpts) {
<form
onSubmit={(e) => {
e.preventDefault();
- if (form.url) onInsert(form.url);
+ if (form.url && !isInserting) void insert(onInsert, form.url);
}}
>
{form.body}
<div className="youtube-video-actions">
- <InsertButton isEnabled={!!form.url} />
+ <InsertButton isEnabled={!!form.url && !isInserting} />
</div>
</form>
);
}
+/**
+ * Inserts a video through `onInsert`, with `isInserting` set until it settles, and shows an error
+ * toast when it fails. `insert()` resolves to whether the video was inserted.
+ */
+function useVideoInsertion() {
+ const [ isInserting, setIsInserting ] = useState(false);
+
+ async function insert(onInsert: YouTubeVideoOpts["onInsert"], url: string) {
+ setIsInserting(true);
+ try {
+ await onInsert(url);
+ return true;
+ } catch (e) {
+ console.error("Failed to insert the YouTube video:", e);
+ toast.showError(t("youtube_video.insert_failed"));
+ return false;
+ } finally {
+ setIsInserting(false);
+ }
+ }
+
+ return { isInserting, insert };
+}
+
/** The button that submits the form, enabled once the field holds the address of a video. */
function InsertButton({ isEnabled }: { isEnabled: boolean }) {
return (
diff --git a/apps/server/src/assets/help/help_content.json b/apps/server/src/assets/help/help_content.json
index 884af87cbb..e90ccbeba3 100644
--- a/apps/server/src/assets/help/help_content.json
+++ b/apps/server/src/assets/help/help_content.json
@@ -138,7 +138,7 @@
"_help_CohkqWQC1iBv": "<p>Press the&nbsp;<span class=\"tn-icon cke cke-plus\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;to reveal special inserable items and blocks such as symbols, Math expressions and separators.</p><h2>Bookmarks</h2><p>See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_oSuaNgyyKnhu\">Anchors</a>&nbsp;section.</p><h2>New child note</h2><p>Choose <span class=\"tn-icon bx bx-subdirectory-right\"></span> <em>New child note</em> to create an empty child note of the current note and insert a link to it at the cursor. The new note opens in <a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a> with its title selected, so typing names it, and the link shows the new title. While the note is still empty, Quick edit offers the note types to turn it into.</p><p>The same action is available as <em>Create a new child note</em> in the <a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>. A child note of a protected note is protected too.</p><h2>Emoji</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:42.4%;\"><img style=\"aspect-ratio:366/410;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Insert%20buttons_plus.png\" width=\"366\" height=\"410\"></figure><p>This feature allows inserting Unicode emoji characters. Simply select a category and a desired emoji to insert it.</p><p>Emojis can also be searched by their English name and the skin tone can be selected via a combo box to the right.</p><p>There is also the possibility of inserting emojis directly by typing <code>:</code> followed by a name of an emoji, triggering the display of a list of emojis. Simply use the arrow keys to select one and press <kbd>Enter</kbd> or <kbd>Tab</kbd> to insert it.</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Insert%20buttons_plus.png\" width=\"272\" height=\"187\"><h2>Symbols</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:346/322;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Insert%20buttons_image.png\" width=\"346\" height=\"322\"></figure><p>Pressing the&nbsp;<span class=\"tn-icon cke cke-special-characters\"></span> button will reveal a popup window displaying a list of characters that are generally more difficult to insert directly from the keyboard, such as a subset of emojis, quotation characters, etc.</p><p>Interaction:</p><ul><li>Click on a character to insert it at the current cursor position.</li><li>The window can be dragged around by the top bar where the title is, to avoid it getting in the way of the text.</li><li>Click on the <em>Category</em> selector to filter the characters.</li></ul><h2>Multicolumn layout</h2><p>See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_wYDzQ1fBFgfT\">Multicolumn layout</a>&nbsp;page.</p><h2>Extended code block</h2><p>Choose <span class=\"tn-icon bx bx-code-block\"></span> <em>Extended code block</em> to insert a code block that is edited as a code note. This entry is experimental and is shown only once it is turned on. See <em>Extended code blocks</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>.</p><h2>Math equations</h2><p>See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;page.</p><h2>Drawing canvas</h2><p>Choose <span class=\"tn-icon bx bx-pen\"></span> <em>Drawing canvas</em> to draw on an Excalidraw canvas inside the text. See <em>Drawing canvases</em> in <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</p><h2>Mermaid diagram</h2><p>Press the&nbsp;<span class=\"tn-icon cke cke-trilium-mermaid-insert\"></span> button to create an inline Mermaid diagram. The arrow next to it lists a template for each kind of diagram. The diagram is also available as <em>Mermaid diagram</em> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>.</p><p>This feature is quite similar to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;note types and is meant as an alternative to it for simple diagrams. For more complex diagrams, use the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;feature for a dedicated Mermaid note.</p><figure class=\"image\"><img style=\"aspect-ratio:1174/358;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Insert%20buttons_image.png\" width=\"1174\" height=\"358\"></figure><p>A diagram shows in a box like the one of an included note, so it can be resized, given another box size (<em>Small</em>, <em>Medium</em> or <em>Full</em>) from its <span class=\"tn-icon cke cke-three-vertical-dots\"></span> <em>More actions</em> menu or shown in fullscreen, as described in&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</p><ul><li>The <span class=\"tn-icon bx bx-edit-alt\"></span> <em>Editable</em> button at the start of the diagram's toolbar decides whether its source can be changed. While it is off, the source still shows, but read-only.</li><li>The buttons next to it choose what the diagram shows, as for a Mermaid note: <span class=\"tn-icon bx bx-code\"></span> <em>Source view</em> for the Mermaid source alone, <span class=\"tn-icon bx bxs-dock-left\"></span> <em>Split view</em> for the source with the diagram next to it, and <span class=\"tn-icon bx bx-show\"></span> <em>Preview</em> for the diagram alone. Its <em>More actions</em> menu offers the same choice.</li><li>The <em>Word wrap</em> and <em>Line numbers</em> submenus of its <em>More actions</em> menu change how the source shows, each with <em>Auto</em>, <em>On</em> and <em>Off</em>, as for an included code note (see <em>Editing an include in place</em> in <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>).</li><li>A new diagram starts editable, in <em>Split view</em>. The diagram updates a moment after you stop typing. If the source has an error, the error shows over the last diagram that worked, which stays dimmed, as in a Mermaid note. On desktop, drag the divider between the source and the diagram to resize them.</li><li>A diagram without a chosen view shows the source next to the diagram while it is editable, and the diagram alone otherwise. In a read-only note, the source can never be changed. A read-only note and the AI chat show a diagram in the same box, in the view it was saved with, and with the zoom buttons over the diagram instead of in a toolbar. A <em>Medium</em> or <em>Full</em> diagram also has a <span class=\"tn-icon bx bx-fullscreen\"></span> <em>Fullscreen</em> button there, or over the source in the <em>Source</em> view.</li><li>To zoom, use the <span class=\"tn-icon bx bx-zoom-out\"></span> and <span class=\"tn-icon bx bx-zoom-in\"></span> buttons of the diagram's toolbar; the zoom level between them resets the zoom. In fullscreen, where the toolbar is hidden, the same buttons show over the diagram. Drag the diagram to move around it, and double-click it to reset the view. The mouse wheel scrolls the note until you click the diagram, and then zooms it.</li><li>While the source shows, the <span class=\"tn-icon bx bx-help-circle\"></span> <em>Mermaid syntax help</em> button at the end of the toolbar opens the help on&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>, which links to the Mermaid syntax.</li><li>The changes made to the source of a diagram are part of the undo history of the text note, in the order they were made. <kbd>Ctrl</kbd>+<kbd>Z</kbd> and <kbd>Ctrl</kbd>+<kbd>Y</kbd> undo and redo them from the source as well as from the text, as described in <em>Editing an include in place</em> in <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</li></ul><p>The source of the diagram stays in the note as a Mermaid code block, so the diagram is exported to Markdown as a <code>mermaid</code> code block that other applications can show.</p><p>Diagrams created in earlier versions keep the view they were saved with, and open editable.</p><h2>YouTube video</h2><p>Choose <span class=\"tn-icon bx bxl-youtube\"></span> <em>YouTube video</em> to insert a YouTube video that can be watched inside the note. Paste the address of the video, then press <em>Insert video</em> or <kbd>Enter</kbd>. The video is inserted as a link preview in the <em>Embed</em> display mode, described in <a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a>. The same action is available as <em>Insert YouTube video</em> in the <a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>.</p><h2>Horizontal ruler</h2><p>This feature will display a horizontal line, generally useful to separate different sections of the text. To do so, press the&nbsp;<span class=\"tn-icon cke cke-horizontal-line\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>.</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Insert%20buttons_image.png\" width=\"502\" height=\"95\"><p>Alternatively, it's possible to insert a horizontal ruler by typing <code>---</code>.</p><h2>Page break</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:371/79;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Insert%20buttons_image.png\" width=\"371\" height=\"79\"></figure><p>Page breaks provide a way to force the next paragraph or block (table, image, etc.) to be displayed onto the next page when printing (either to a real printer to <a href=\"#root/_help_NRnIZmSMc5sj\">when exporting to PDF</a>).</p><p>Page breaks are marked in the editor with the words <em>Page break</em>, but they will not actually be shown when printed.</p><ul><li>To insert a page break, press the&nbsp;<span class=\"tn-icon cke cke-page-break\"></span> in the formatting toolbar.</li><li>To insert many page breaks at once, insert a page break first, click on it and press <kbd>Ctrl</kbd>+<kbd>C</kbd>. Then use <kbd>Ctrl</kbd>+<kbd>V</kbd>, to paste as many times as needed.</li></ul><h2>Date and time</h2><p>The <span class=\"tn-icon cke cke-trilium-date-time\"></span> button inserts the current date and time at the cursor, replacing the selected text if there is any. The inserted text takes the formatting of the text around it, so a date inserted inside bold text is bold too.</p><ul><li>To insert the date in the default format, press the button itself or press <kbd>Alt</kbd>+<kbd>T</kbd>.</li><li>To insert it in another format, press the arrow next to the button and pick a format from the list. Each entry shows the current date and time in that format: the default one, the date or the time alone, the date written out, and ISO 8601.</li><li>The same formats are offered by the <a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>: type <code>/date</code>, <code>/time</code>, <code>/now</code> or <code>/today</code>. The <em>Insert date/time</em> entry uses the default format, and shows what it inserts underneath; the other entries show their output in the title.</li></ul><p>The default format can be changed in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Text Notes</em> → <em>Editor</em> → <em>Date/time format</em>, using <a href=\"https://day.js.org/docs/en/display/format\">Day.js format tokens</a> (for example <code>DD.MM.YYYY HH:mm</code>).</p><h2>Icons</h2><p>Icons just like the ones for the <a href=\"#root/_help_p9kXRFAkwN4o\">note icon</a> can be inserted in text. For more information see&nbsp;<a class=\"reference-link\" href=\"#root/_help_hD8GawVuazff\">Icons</a>.</p>",
"_help_hD8GawVuazff": "<p>Icons just like the <a href=\"#root/_help_hD8GawVuazff\">note icons</a> can be inserted in the content of a note, including from any other <a href=\"#root/_help_gOKqSJgXLcIj\">custom icon packs</a>.</p><h2>Features</h2><ul><li>The icon can be formatted through the<a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a>&nbsp;tools of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>:<ul><li>Foreground/icon color</li><li>Background color/highlight</li><li>Font size</li></ul></li><li>Custom&nbsp;<a class=\"reference-link\" href=\"#root/_help_gOKqSJgXLcIj\">Icon Packs</a>&nbsp;are also supported.<ul><li>For emojis, prefer the Emoji functionality from&nbsp;<a class=\"reference-link\" href=\"#root/_help_CohkqWQC1iBv\">Insert buttons</a>.</li></ul></li><li>When an icon is clicked a floating toolbar appears with the following functions:<ul><li><span class=\"tn-icon bx bx-sticker\"></span>&nbsp;which changes the icon.</li><li><span class=\"tn-icon bx bx-reflect-horizontal\"></span>&nbsp;which applies transforms: rotate (90 / 180 / 270) and flip horizontal/vertical. Only one transform can be used per icon.</li></ul></li></ul><h2>Usage</h2><ul><li>The in-app help/user guide makes use of these icons in order to illustrate buttons in the UI.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_GnhlmrATVqcH\">Microsoft OneNote</a>&nbsp;importer also makes use of them for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_LpvyEIBIAAj7\">Tags</a>.</li></ul><h2>Inserting an icon</h2><p>There are two ways to insert an icon:</p><ul><li>Via the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;look for the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> icon and then the&nbsp;<span class=\"tn-icon bx bx-sticker\"></span> icon.</li><li>Via&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>, type <code>/icon</code>.</li></ul><p>An icon picker will appear, search for an icon and click it to insert it in the document.</p><h2>Finding notes by their icons</h2><p>An icon can be <a href=\"#root/_help_eIg8jdvaoNNd\">searched</a>. A note containing a&nbsp;<span class=\"tn-icon bx bx-star\"></span> icon can be found by searching for <code>star</code>, or its <code>iconClass</code> (<code>bx-star</code>).</p><p>To find the name of the icon, hover the mouse over an icon while in the icon picker.</p><h2>Markdown rendering</h2><p>When exporting to&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>, the item will render as raw HTML representation of the icon as is used by Trilium:</p><pre><code class=\"language-text-html\">&lt;span class=\"tn-icon bx bx-star\"&gt;&lt;/span&gt;</code></pre>",
"_help_oiVPnW8QfnvS": "<h2>Trilium-specific shortcuts</h2><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Bring up inline formatting toolbar (arrow keys ←,→ to navigate, Enter to apply)</td><td>Alt+F10</td><td>⌥+F10</td></tr><tr><td>Bring up block formatting toolbar</td><td>Alt+F10</td><td>⌥+F10</td></tr><tr><td>Create <a href=\"#root/_help_QEAPj01N5f7w\">external link</a></td><td>Ctrl+K</td><td>⌘+K</td></tr><tr><td>Create <a href=\"#root/_help_QEAPj01N5f7w\">internal (note) link</a></td><td>Ctrl+L</td><td>⌘+L</td></tr><tr><td>Inserts current date and time at caret position</td><td>Alt+T</td><td>⌥+T</td></tr><tr><td>Increase paragraph indentation</td><td>Tab</td><td>⇥</td></tr><tr><td>Decrease paragraph indentation</td><td>Shift + Tab</td><td>⇧ + ⇥</td></tr><tr><td>Mark selected text as <a href=\"#root/_help_UYuUB1ZekNQU\">keyboard shortcut</a></td><td>Ctrl + Alt + K</td><td>⌘+ ⌥+ K</td></tr><tr><td>Insert&nbsp;<a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></td><td>Ctrl + M</td><td>⌘+ M</td></tr><tr><td>Move blocks (lists, paragraphs, etc.) up, or in a <a href=\"#root/_help_NdowYOC1GFKS\">table</a> the rows</td><td>Alt+↑</td><td>⌥+↑</td></tr><tr><td>Move blocks (lists, paragraphs, etc.) down, or in a <a href=\"#root/_help_NdowYOC1GFKS\">table</a> the rows</td><td>Alt+↓</td><td>⌥+↓</td></tr><tr><td>Move the selected content to another column of a <a class=\"reference-link\" href=\"#root/_help_wYDzQ1fBFgfT\">Multicolumn layout</a></td><td>Ctrl+←, Ctrl+→, Ctrl+Shift+Home, Ctrl+Shift+End</td><td>⌘+←, ⌘+→, ⌘+⇧+Home, ⌘+⇧+End</td></tr><tr><td>Move the current column of a multicolumn layout</td><td>Ctrl+Alt+←, Ctrl+Alt+→, Ctrl+Alt+Home, Ctrl+Alt+End</td><td>⌘+⌥+←, ⌘+⌥+→, ⌘+⌥+Home, ⌘+⌥+End</td></tr><tr><td>Add a column after or before the current one in a multicolumn layout</td><td>Ctrl+Enter, Ctrl+Shift+Enter</td><td>⌘+Enter, ⌘+⇧+Enter</td></tr><tr><td>Move the selected content to another tab in <a class=\"reference-link\" href=\"#root/_help_EK2ckIZ74tbT\">Content tabs</a></td><td>Ctrl+←, Ctrl+→, Ctrl+Shift+Home, Ctrl+Shift+End</td><td>⌘+←, ⌘+→, ⌘+⇧+Home, ⌘+⇧+End</td></tr><tr><td>Move the current tab of a tabs block</td><td>Ctrl+Alt+←, Ctrl+Alt+→, Ctrl+Alt+Home, Ctrl+Alt+End</td><td>⌘+⌥+←, ⌘+⌥+→, ⌘+⌥+Home, ⌘+⌥+End</td></tr><tr><td>Add a tab after or before the current one in a tabs block</td><td>Ctrl+Enter, Ctrl+Shift+Enter</td><td>⌘+Enter, ⌘+⇧+Enter</td></tr></tbody></table></figure><h2>Common shortcuts</h2><aside class=\"admonition tip\"><p>This section of keyboard shortcuts presents a subset of the keyboard shortcuts as supported by the editor technology we are using,&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>. The shortcuts were taken from the <a href=\"https://ckeditor.com/docs/ckeditor5/latest/features/accessibility.html#keyboard-shortcuts\">official documentation</a>. Note that not all the shortcuts in the original documentation are applicable (due to using a different configuration).</p></aside><h3>Content editing</h3><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Insert a hard break (a new paragraph)</td><td>Enter</td><td></td></tr><tr><td>Insert a soft break (a <code>&lt;br&gt;</code> element)</td><td>Shift+Enter</td><td>⇧Enter</td></tr><tr><td>Copy selected content</td><td>Ctrl+C</td><td>⌘C</td></tr><tr><td>Paste content</td><td>Ctrl+V</td><td>⌘V</td></tr><tr><td>Paste content as plain text</td><td>Ctrl+Shift+V</td><td>⌘⇧V</td></tr><tr><td>Undo</td><td>Ctrl+Z</td><td>⌘Z</td></tr><tr><td>Redo</td><td>Ctrl+Y, Ctrl+Shift+Z</td><td>⌘Y, ⌘⇧Z</td></tr><tr><td>Bold text</td><td>Ctrl+B</td><td>⌘B</td></tr><tr><td>Change text case</td><td>Shift+F3</td><td>⇧F3 (may require Fn)</td></tr><tr><td>Create link</td><td>Ctrl+K</td><td>⌘K</td></tr><tr><td>Move out of a link</td><td>←←, →→</td><td></td></tr><tr><td>Move out of an inline code style</td><td>←←, →→</td><td></td></tr><tr><td>Select all</td><td>Ctrl+A</td><td>⌘A</td></tr><tr><td>Find in the document</td><td>Ctrl+F</td><td>⌘F</td></tr><tr><td>Copy text formatting</td><td>Ctrl+Shift+C</td><td>⌘⇧C</td></tr><tr><td>Paste text formatting</td><td>Ctrl+Shift+V</td><td>⌘⇧V</td></tr><tr><td>Italic text</td><td>Ctrl+I</td><td>⌘I</td></tr><tr><td>Strikethrough text</td><td>Ctrl+Shift+X</td><td>⌘⇧X</td></tr><tr><td>Underline text</td><td>Ctrl+U</td><td>⌘U</td></tr><tr><td>Revert autoformatting action</td><td>Backspace</td><td></td></tr></tbody></table></figure><h3>Interacting with blocks</h3><p>Blocks are images, tables, blockquotes, annotations.</p><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Insert a new paragraph directly after a widget</td><td>Enter</td><td></td></tr><tr><td>Insert a new paragraph directly before a widget</td><td>Shift+Enter</td><td>⇧Enter</td></tr><tr><td>Move the caret to allow typing directly before a widget</td><td>↑, ←</td><td></td></tr><tr><td>Move the caret to allow typing directly after a widget</td><td>↓, →</td><td></td></tr><tr><td>After entering a nested editable, move the selection to the closest ancestor widget. For example: move from an image caption to the whole image widget.</td><td>Tab then Esc</td><td></td></tr></tbody></table></figure><p>Specifically for lists:</p><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Increase list item indent</td><td>⇥</td><td></td></tr><tr><td>Decrease list item indent</td><td>Shift+⇥</td><td>⇧⇥</td></tr></tbody></table></figure><p>In tables:</p><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Move the selection to the next cell</td><td>⇥</td><td></td></tr><tr><td>Move the selection to the previous cell</td><td>Shift+⇥</td><td>⇧⇥</td></tr><tr><td>Insert a new table row (when in the last cell of a table)</td><td>⇥</td><td></td></tr><tr><td>Navigate through the table</td><td>↑, →, ↓, ←</td><td></td></tr></tbody></table></figure><h3>General UI shortcuts</h3><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Close contextual balloons, dropdowns, and dialogs</td><td>Esc</td><td></td></tr><tr><td>Open the accessibility help dialog</td><td>Alt+0</td><td>⌥0</td></tr><tr><td>Move focus between form fields (inputs, buttons, etc.)</td><td>⇥, Shift+⇥</td><td>⇥, ⇧⇥</td></tr><tr><td>Move focus to the toolbar, navigate between toolbars</td><td>Alt+F10</td><td>⌥F10 (may require Fn)</td></tr><tr><td>Navigate through the toolbar or menu bar</td><td>↑, →, ↓, ←</td><td></td></tr><tr><td>Navigate to the next focusable field or an element outside the editor</td><td>Tab, Shift+Tab</td><td></td></tr><tr><td>Execute the currently focused button. Executing buttons that interact with the editor content moves the focus back to the content.</td><td>Enter, Space</td><td></td></tr><tr><td>Move focus in and out of an active dialog window</td><td>Ctrl+F6</td><td>⌘F6 (may require Fn)</td></tr></tbody></table></figure>",
- "_help_UmgZAfcltxkS": "<p>Link previews turn a pasted URL into a rich, metadata-aware widget that can be displayed in three visual modes:</p><h2>Display modes</h2><p>A link preview can be displayed in one of three modes:</p><ul><li><strong>Inline</strong> — a link showing the site's favicon and page title (quite similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>). Use this when you want the link to flow with the surrounding paragraph.</li><li><strong>Card</strong> — a block-level preview with thumbnail, title, description, and site name. Use this when the link is the focus of a paragraph.</li><li><strong>Embed</strong> — a block-level interactive embed.<ul><li>Currently supported for YouTube videos, which render interactively (via an <code>iframe</code>).</li><li>To prevent unwanted remote requests, the video is shown only after clicking on it first. Until then, the video's thumbnail is shown with a play button.</li><li>The video can be resized and aligned (see <em>Videos</em> below).</li></ul></li></ul><div class=\"trilium-multicolumn-layout\" data-trilium-column-ratios=\"1-1-1\"><div class=\"trilium-multicolumn-column\"><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:251/42;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Link%20Previews_image.png\" width=\"251\" height=\"42\"><figcaption><em>Inline</em> link preview</figcaption></figure></div><div class=\"trilium-multicolumn-column\"><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:1217/196;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Link%20Previews_image.png\" width=\"1217\" height=\"196\"><figcaption><em>Card</em> link preview</figcaption></figure></div><div class=\"trilium-multicolumn-column\"><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:994/563;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Link%20Previews_image.png\" width=\"994\" height=\"563\"><figcaption><em>Embed</em> link preview</figcaption></figure></div></div><h2>Inserting a link preview</h2><p>There are four ways to create one:</p><h3>1. By pasting a URL</h3><p>A link preview is automatically created:</p><ul><li>By pasting the URL and pressing <kbd>Space</kbd>. This will create an <em>inline</em> link preview.</li><li>When at the start of a new paragraph, pressing <kbd>Enter</kbd> will create a <em>card</em> or an <em>embed</em> for YouTube URLs.</li></ul><p>To undo an automatic link preview, press <kbd>Ctrl</kbd>+<kbd>Z</kbd> immediately afterwards which keeps it as a plain link instead. Alternatively, once a link preview was created, click on the link and select <em>Plain link</em> from the link preview toolbar.</p><p>This automatic conversion can be disabled by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text Notes</em> and unchecking <em>Autogenerate link previews</em> from the <em>Features</em> section.</p><p>If the link is not accessible to the Trilium server (or the network request fails for any other reason), it will not be converted to a link preview.</p><aside class=\"admonition note\"><p>A URL is only auto-converted when the pasted text <em>is</em> the URL. Links with a display name (e.g. <a href=\"https://triliumnotes.org\">Trilium Notes website</a>) are left as plain links.</p></aside><h3>2. From the link dialog</h3><p>Since v0.107.0, a link preview is created from the same <em>Add link</em> dialog as any other link (see <a class=\"reference-link\" href=\"#root/_help_3IDVtesTQ8ds\">External links</a>):</p><ul><li>Press <span class=\"tn-icon cke cke-link\"></span> in the <a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, or press <kbd>Ctrl</kbd>+<kbd>K</kbd>, to open the dialog on <em>Web link</em>.</li><li>Type or paste the address, then pick the preview in <em>Display as</em>: <em>Inline</em>, <em>Card</em> or, for a YouTube video, <em>YouTube embed</em>. <em>Plain link</em> inserts an ordinary link. <em>Display as</em> is not shown when text is selected, since the link then keeps the selected text.</li><li>Optionally, type a <em>Link title</em> to show instead of the page's own title. A <em>Card</em> also offers a <em>Description</em> to show instead of the page's own description.</li><li>Press <kbd>Enter</kbd> or <em>Insert link</em> to confirm. The link appears right away and turns into the preview once Trilium has read the page.</li></ul><p>Alternatively, use <a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a> and look for <em>link preview</em> (it is also found by <em>embed</em>, <em>url</em> or <em>video</em>). It opens the same dialog with a preview already picked: a <em>YouTube embed</em> for a YouTube video, a <em>Card</em> for any other page.</p><p>To turn an existing link into a preview, open its <em>Edit link</em> dialog and change <em>Display as</em>. A link whose text differs from its address keeps that text as the title of the preview.</p><h3>3. From the Insert menu, for a YouTube video</h3><p>Choose <span class=\"tn-icon bx bxl-youtube\"></span> <em>YouTube video</em> from the <a class=\"reference-link\" href=\"#root/_help_CohkqWQC1iBv\">Insert buttons</a> menu, or <em>Insert YouTube video</em> from the <a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>. Paste the address of the video and press <em>Insert video</em> or <kbd>Enter</kbd> to insert it as an <em>Embed</em>.</p><h3>4. By saving browser tabs from the Web Clipper</h3><p>When the&nbsp;<a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>&nbsp;saves the tabs of a window, each tab becomes an <em>inline</em> link preview showing the title and favicon the browser displays for it. Because this data comes from the browser, pages behind a login keep their real title, and the Trilium server does not contact the saved pages.</p><p>When <em>Autogenerate link previews</em> is turned off, the tabs are saved as a list of plain links instead.</p><h2>Altering an existing link preview</h2><p>Click on an inserted <em>Inline</em> or <em>Card</em> link preview to select it, and a small toolbar will appear with the following options:</p><ul><li>The normal link operations (opening in a new tab, copying the link, unlinking).</li><li>The <span class=\"tn-icon cke cke-pencil\"></span> <em>Edit link</em> button, which opens the <em>Edit link</em> dialog on the link preview, as does pressing <kbd>Ctrl</kbd>+<kbd>K</kbd> while it is selected. The dialog changes its address, its <em>Link title</em> (especially useful if the title is hidden behind a login screen), the <em>Description</em> of a card and how it is displayed. A new address shows the title and description of the new page, unless you type your own.</li><li>A way to switch between the link preview modes (Inline, Card or Embed) as well as to convert it to a normal link instead.<ul><li>The Embed option is only enabled when the URL points to a supported service (YouTube today).</li></ul></li></ul><h3>Videos</h3><p>A YouTube video shown as an <em>Embed</em> has a size, a position and a title, like an <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>. It keeps the shape of the video, so a YouTube Short stands upright and an older video can be 4:3. A video inserted in an earlier version is 16:9 until it is inserted again. In the editor, a click on the video both plays it and selects it, and so does a later click on the player. The toolbar of a selected video offers:</p><ul><li><span class=\"tn-icon cke cke-trilium-copy\"></span> <em>Copy URL</em>.</li><li>The <em>Display</em> menu, which turns the video into an <em>Inline</em> or <em>Card</em> link preview, or a <em>Plain link</em>.</li><li>The <span class=\"tn-icon cke cke-three-vertical-dots\"></span> <em>More actions</em> menu:<ul><li><span class=\"tn-icon bx bx-link-external\"></span> <em>Open externally</em> opens the video outside Trilium: in the browser, or in the app that handles the link, such as the YouTube app on Android.</li><li><em>Size</em>: a <em>Medium</em> video can be resized, a <em>Full</em> video takes the width of the note, or less when it would be taller than most of the window. A new video is <em>Medium</em>. A video inserted in an earlier version is <em>Full</em>.</li><li><em>Position</em>: under <em>Break text</em>, <span class=\"tn-icon cke cke-object-left\"></span> <em>Align left</em>, <span class=\"tn-icon cke cke-object-center\"></span> <em>Align center</em> and <span class=\"tn-icon cke cke-object-right\"></span> <em>Align right</em> place the video on lines of its own, at that side of the note. Under <em>Wrap text</em>, <span class=\"tn-icon cke cke-object-inline-left\"></span> <em>Align left</em> and <span class=\"tn-icon cke cke-object-inline-right\"></span> <em>Align right</em> place it at that side and let the text run beside it. <em>Align center</em> is the default.</li><li><em>Show title</em> shows the title of the video above it, as a link to the video. The <span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> button of the title opens this same menu.</li><li><span class=\"tn-icon bx bx-trash\"></span> <em>Delete</em> removes the video from the note.</li></ul></li></ul><p>To resize a <em>Medium</em> video, select it and drag the handle in its bottom-right corner, or its bottom-left corner for a video aligned to the right. The height follows the width. Choosing <em>Medium</em> again returns the video to its first size.</p><p>On a <a href=\"#root/_help_R9pX4DGra2Vt\">shared page</a>, the video keeps its width and position, but not its title. In the mobile layout, a video with a position other than <em>Align center</em> takes the full width.</p><h2>Where the preview data comes from</h2><p>When you insert a link preview, Trilium fetches metadata once and stores it with the note:</p><ul><li><strong>YouTube URLs</strong>: the title, the channel name and the shape of the video are fetched via YouTube's public oEmbed endpoint, and the video's thumbnail is downloaded at up to 1280×720.</li><li><strong>All other URLs</strong>: Trilium fetches the page and reads OpenGraph tags (<code>og:title</code>, <code>og:description</code>, <code>og:image</code>, <code>og:site_name</code>), falling back to the page's <code>&lt;title&gt;</code> and <code>&lt;meta name=\"description\"&gt;</code>. The site's favicon and the page's image are downloaded as well.</li></ul><p>The text is kept in the note's HTML. The images are kept as system&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a> of the note, listed under <em>Generated by Trilium</em>.</p><p>Because the data is stored in the note itself, link previews continue to render correctly when you reopen the note, share/publish it, or export to HTML — without any further network requests.</p><p>The metadata is captured <strong>at insertion time</strong> and is not automatically refreshed. If the linked page later changes its title or thumbnail, you'll need to re-insert the link to pick up the new values. To refresh a link, simply create it again.</p><p>A YouTube embed inserted before v0.107.0 keeps its smaller thumbnail, shown blurred, until the link is inserted again.</p><p>When accessing a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>, the data is fetched from the remote URL by the server and not the client.</p><h2>Known limitations</h2><ul><li>The Embed display mode currently only supports YouTube. Other video and media platforms fall back to a Card preview.</li><li>Pages that block automated fetches may produce a minimal preview (hostname only).</li><li>Link previews require the Trilium server to reach the target URL, so they won't generate previews for pages on networks the server can't see.</li></ul>",
+ "_help_UmgZAfcltxkS": "<p>Link previews turn a pasted URL into a rich, metadata-aware widget that can be displayed in three visual modes:</p><h2>Display modes</h2><p>A link preview can be displayed in one of three modes:</p><ul><li><strong>Inline</strong> — a link showing the site's favicon and page title (quite similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>). Use this when you want the link to flow with the surrounding paragraph.</li><li><strong>Card</strong> — a block-level preview with thumbnail, title, description, and site name. Use this when the link is the focus of a paragraph.</li><li><strong>Embed</strong> — a block-level interactive embed.<ul><li>Currently supported for YouTube videos, which render interactively (via an <code>iframe</code>).</li><li>To prevent unwanted remote requests, the video is shown only after clicking on it first. Until then, the video's thumbnail is shown with a play button.</li><li>The video can be resized and aligned (see <em>Videos</em> below).</li></ul></li></ul><div class=\"trilium-multicolumn-layout\" data-trilium-column-ratios=\"1-1-1\"><div class=\"trilium-multicolumn-column\"><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:251/42;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Link%20Previews_image.png\" width=\"251\" height=\"42\"><figcaption><em>Inline</em> link preview</figcaption></figure></div><div class=\"trilium-multicolumn-column\"><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:1217/196;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Link%20Previews_image.png\" width=\"1217\" height=\"196\"><figcaption><em>Card</em> link preview</figcaption></figure></div><div class=\"trilium-multicolumn-column\"><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:994/563;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Link%20Previews_image.png\" width=\"994\" height=\"563\"><figcaption><em>Embed</em> link preview</figcaption></figure></div></div><h2>Inserting a link preview</h2><p>There are four ways to create one:</p><h3>1. By pasting a URL</h3><p>A link preview is automatically created:</p><ul><li>By pasting the URL and pressing <kbd>Space</kbd>. This will create an <em>inline</em> link preview.</li><li>When at the start of a new paragraph, pressing <kbd>Enter</kbd> will create a <em>card</em> or an <em>embed</em> for YouTube URLs.</li></ul><p>To undo an automatic link preview, press <kbd>Ctrl</kbd>+<kbd>Z</kbd> immediately afterwards which keeps it as a plain link instead. Alternatively, once a link preview was created, click on the link and select <em>Plain link</em> from the link preview toolbar.</p><p>This automatic conversion can be disabled by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text Notes</em> and unchecking <em>Autogenerate link previews</em> from the <em>Features</em> section.</p><p>If the link is not accessible to the Trilium server (or the network request fails for any other reason), it will not be converted to a link preview.</p><aside class=\"admonition note\"><p>A URL is only auto-converted when the pasted text <em>is</em> the URL. Links with a display name (e.g. <a href=\"https://triliumnotes.org\">Trilium Notes website</a>) are left as plain links.</p></aside><h3>2. From the link dialog</h3><p>Since v0.107.0, a link preview is created from the same <em>Add link</em> dialog as any other link (see <a class=\"reference-link\" href=\"#root/_help_3IDVtesTQ8ds\">External links</a>):</p><ul><li>Press <span class=\"tn-icon cke cke-link\"></span> in the <a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, or press <kbd>Ctrl</kbd>+<kbd>K</kbd>, to open the dialog on <em>Web link</em>.</li><li>Type or paste the address, then pick the preview in <em>Display as</em>: <em>Inline</em>, <em>Card</em> or, for a YouTube video, <em>YouTube embed</em>. <em>Plain link</em> inserts an ordinary link. <em>Display as</em> is not shown when text is selected, since the link then keeps the selected text.</li><li>Optionally, type a <em>Link title</em> to show instead of the page's own title. A <em>Card</em> also offers a <em>Description</em> to show instead of the page's own description.</li><li>Press <kbd>Enter</kbd> or <em>Insert link</em> to confirm. The link appears right away and turns into the preview once Trilium has read the page.</li></ul><p>Alternatively, use <a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a> and look for <em>link preview</em> (it is also found by <em>embed</em>, <em>url</em> or <em>video</em>). It opens the same dialog with a preview already picked: a <em>YouTube embed</em> for a YouTube video, a <em>Card</em> for any other page.</p><p>To turn an existing link into a preview, open its <em>Edit link</em> dialog and change <em>Display as</em>. A link whose text differs from its address keeps that text as the title of the preview.</p><h3>3. From the Insert menu, for a YouTube video</h3><p>Choose <span class=\"tn-icon bx bxl-youtube\"></span> <em>YouTube video</em> from the <a class=\"reference-link\" href=\"#root/_help_CohkqWQC1iBv\">Insert buttons</a> menu, or <em>Insert YouTube video</em> from the <a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>. Paste the address of the video and press <em>Insert video</em> or <kbd>Enter</kbd> to insert it as an <em>Embed</em>. The video is inserted once its title and thumbnail have loaded, which can take a few seconds. When they cannot be loaded, an error is shown and the prompt stays open.</p><h3>4. By saving browser tabs from the Web Clipper</h3><p>When the&nbsp;<a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>&nbsp;saves the tabs of a window, each tab becomes an <em>inline</em> link preview showing the title and favicon the browser displays for it. Because this data comes from the browser, pages behind a login keep their real title, and the Trilium server does not contact the saved pages.</p><p>When <em>Autogenerate link previews</em> is turned off, the tabs are saved as a list of plain links instead.</p><h2>Altering an existing link preview</h2><p>Click on an inserted <em>Inline</em> or <em>Card</em> link preview to select it, and a small toolbar will appear with the following options:</p><ul><li>The normal link operations (opening in a new tab, copying the link, unlinking).</li><li>The <span class=\"tn-icon cke cke-pencil\"></span> <em>Edit link</em> button, which opens the <em>Edit link</em> dialog on the link preview, as does pressing <kbd>Ctrl</kbd>+<kbd>K</kbd> while it is selected. The dialog changes its address, its <em>Link title</em> (especially useful if the title is hidden behind a login screen), the <em>Description</em> of a card and how it is displayed. A new address shows the title and description of the new page, unless you type your own.</li><li>A way to switch between the link preview modes (Inline, Card or Embed) as well as to convert it to a normal link instead.<ul><li>The Embed option is only enabled when the URL points to a supported service (YouTube today).</li></ul></li></ul><h3>Videos</h3><p>A YouTube video shown as an <em>Embed</em> has a size, a position and a title, like an <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>. It keeps the shape of the video, so a YouTube Short stands upright and an older video can be 4:3. A video inserted in an earlier version is 16:9 until it is inserted again. In the editor, a click on the video both plays it and selects it, and so does a later click on the player. The toolbar of a selected video offers:</p><ul><li><span class=\"tn-icon cke cke-trilium-copy\"></span> <em>Copy URL</em>.</li><li>The <em>Display</em> menu, which turns the video into an <em>Inline</em> or <em>Card</em> link preview, or a <em>Plain link</em>.</li><li>The <span class=\"tn-icon cke cke-three-vertical-dots\"></span> <em>More actions</em> menu:<ul><li><span class=\"tn-icon bx bx-link-external\"></span> <em>Open externally</em> opens the video outside Trilium: in the browser, or in the app that handles the link, such as the YouTube app on Android.</li><li><em>Size</em>: a <em>Medium</em> video can be resized, a <em>Full</em> video takes the width of the note, or less when it would be taller than most of the window. A new video is <em>Medium</em>. A video inserted in an earlier version is <em>Full</em>.</li><li><em>Position</em>: under <em>Break text</em>, <span class=\"tn-icon cke cke-object-left\"></span> <em>Align left</em>, <span class=\"tn-icon cke cke-object-center\"></span> <em>Align center</em> and <span class=\"tn-icon cke cke-object-right\"></span> <em>Align right</em> place the video on lines of its own, at that side of the note. Under <em>Wrap text</em>, <span class=\"tn-icon cke cke-object-inline-left\"></span> <em>Align left</em> and <span class=\"tn-icon cke cke-object-inline-right\"></span> <em>Align right</em> place it at that side and let the text run beside it. <em>Align center</em> is the default.</li><li><em>Show title</em> shows the title of the video above it, as a link to the video. The <span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> button of the title opens this same menu.</li><li><span class=\"tn-icon bx bx-trash\"></span> <em>Delete</em> removes the video from the note.</li></ul></li></ul><p>To resize a <em>Medium</em> video, select it and drag the handle in its bottom-right corner, or its bottom-left corner for a video aligned to the right. The height follows the width. Choosing <em>Medium</em> again returns the video to its first size.</p><p>On a <a href=\"#root/_help_R9pX4DGra2Vt\">shared page</a>, the video keeps its width and position, but not its title. In the mobile layout, a video with a position other than <em>Align center</em> takes the full width.</p><h2>Where the preview data comes from</h2><p>When you insert a link preview, Trilium fetches metadata once and stores it with the note:</p><ul><li><strong>YouTube URLs</strong>: the title, the channel name and the shape of the video are fetched via YouTube's public oEmbed endpoint, and the video's thumbnail is downloaded at up to 1280×720.</li><li><strong>All other URLs</strong>: Trilium fetches the page and reads OpenGraph tags (<code>og:title</code>, <code>og:description</code>, <code>og:image</code>, <code>og:site_name</code>), falling back to the page's <code>&lt;title&gt;</code> and <code>&lt;meta name=\"description\"&gt;</code>. The site's favicon and the page's image are downloaded as well.</li></ul><p>The text is kept in the note's HTML. The images are kept as system&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a> of the note, listed under <em>Generated by Trilium</em>.</p><p>Because the data is stored in the note itself, link previews continue to render correctly when you reopen the note, share/publish it, or export to HTML — without any further network requests.</p><p>The metadata is captured <strong>at insertion time</strong> and is not automatically refreshed. If the linked page later changes its title or thumbnail, you'll need to re-insert the link to pick up the new values. To refresh a link, simply create it again.</p><p>A YouTube embed inserted before v0.107.0 keeps its smaller thumbnail, shown blurred, until the link is inserted again.</p><p>When accessing a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>, the data is fetched from the remote URL by the server and not the client.</p><h2>Known limitations</h2><ul><li>The Embed display mode currently only supports YouTube. Other video and media platforms fall back to a Card preview.</li><li>Pages that block automated fetches may produce a minimal preview (hostname only).</li><li>Link previews require the Trilium server to reach the target URL, so they won't generate previews for pages on networks the server can't see.</li></ul>",
"_help_QEAPj01N5f7w": "<p>There are two types of links:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_3IDVtesTQ8ds\">External links</a>, for standard hyperlinks to websites or other resources.</li><li><a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;for links to other notes within Trilium.<ul><li>The list of notes that refer to a particular note is called&nbsp;<a class=\"reference-link\" href=\"#root/_help_wfGXLmm7x27z\">Backlinks</a>.</li></ul></li></ul><h2>Note map</h2><p>Trilium provides a visualization of incoming and outgoing links for a particular note. See <a href=\"#root/_help_BCkXAVs63Ttv\">note map</a> for details.</p>",
"_help_3IDVtesTQ8ds": "<p>An external link is a standard web link targeting for example a website. For example, <a href=\"https://en.wikipedia.org/wiki/South_China_Sea\">https://en.wikipedia.org/wiki/South_China_Sea</a> is an external link to a Wikipedia page.</p><p>To create a link without a custom text:</p><ul><li>Press&nbsp;<span class=\"tn-icon cke cke-link\"></span> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, or press <kbd>Ctrl</kbd>+<kbd>K</kbd>:<ul><li>Since v0.107.0, the <em>Add link</em> dialog opens on <em>Web link</em>, in a popup next to the cursor on desktop. Type or paste the address, and optionally a <em>Link title</em>; without one, the link shows its address.</li><li><em>Display as</em> inserts the address as a <em>Plain link</em>, or as one of the <a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a>: <em>Inline</em>, <em>Card</em> or, for a YouTube video, <em>YouTube embed</em>.</li><li>Press <kbd>Enter</kbd> or <em>Insert link</em> to confirm.</li></ul></li><li>A simpler way is to paste the raw link and press space to turn it automatically into a link.</li><li>The&nbsp;<span class=\"tn-icon cke cke-trilium\"></span> button and <kbd>Ctrl</kbd>+<kbd>L</kbd> of&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a> open the same dialog on <em>Note</em>. Select <em>Web link</em> at the top of the dialog to create an external link from there.</li></ul><p>An address without a scheme, such as <code>example.com</code>, gets <code>https://</code>. A URL pasted into the <em>Note</em> field, or picked from its search, switches the dialog to <em>Web link</em>. The dialog also opens on <em>Web link</em> when the selected text is a URL.</p><p>To create a link with a custom text:</p><ul><li>First, type and select the text which will be turned into a link.</li><li>Open the <em>Add link</em> dialog as above (via the formatting toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>). The selected text becomes the text of the link, so the dialog does not offer <em>Display as</em>.</li><li>Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected text to turn it into a link.</li></ul><p>Once a link is inserted:</p><ul><li>The text inside the link can be changed if needed but the link itself will remain.</li><li>To modify the link, click on the link to display the popup and press the&nbsp;<span class=\"tn-icon cke cke-pencil\"></span> <em>Edit link</em> button. It opens the <em>Edit link</em> dialog, filled with the link's address and text, as do placing the cursor inside the link and pressing <kbd>Ctrl</kbd>+<kbd>K</kbd>, <kbd>Ctrl</kbd>+<kbd>L</kbd> or one of the link buttons. <em>Save link</em> changes the whole link, its text included, and the dialog can also turn it into a link to a note.</li><li>To remove a link, click on it and press the&nbsp;<span class=\"tn-icon cke cke-unlink\"></span> <em>Unlink</em> button.</li></ul><p>You can follow external link by either double clicking (will open new tab/window) it or right clicking on them and choosing \"Open in new tab\".</p>",
"_help_hrZ1D00cLbal": "<p>Internal links are links to other notes within Trilium.</p><p>You can open an internal link by clicking it. You can also see a read-only preview of an internal link's contents by hovering over it.</p><p>Since v0.107.0, clicking an internal link while editing a text note shows its popup instead, as clicking an external link does:</p><ul><li><em>Open note</em> opens the linked note, or <em>Open attachment</em> for a link to an attachment. A link into the same note reads <em>Jump to heading</em>, <em>Jump to block</em> or <em>Jump to anchor</em> instead, and scrolls to it without leaving the note.</li><li><span class=\"tn-icon cke cke-trilium-copy\"></span> <em>Copy URL</em> copies the address of the link.</li><li><span class=\"tn-icon cke cke-pencil\"></span> <em>Edit link</em> changes the link, as described below.</li><li><span class=\"tn-icon cke cke-unlink\"></span> <em>Unlink</em> turns the link into plain text.</li></ul><p>To open the note in a new tab without the popup, <kbd>Ctrl</kbd>+click or double-click the link. The preview does not show while the popup is open.</p><h2>Inserting internal links</h2><p>Internal links can be created at the current position in a text note by:</p><ol><li>Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the&nbsp;<span class=\"tn-icon cke cke-trilium\"></span> button underneath the&nbsp;<span class=\"tn-icon cke cke-plus\"></span> menu in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>. On desktop, the <em>Add link</em> dialog opens in a popup next to the cursor.</li><li>Searching for the title of the desired note to link. It's also possible to create new notes from this dialog by typing a non-existing note title and selecting either <em>Create note</em>, which places it in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>&nbsp;(today's day note, or the top level, when no inbox is set), or <em>Create child note</em>, which places it under the note being edited.</li></ol><p>There are two link types, depending on the <em>Link title</em> field of the dialog:</p><ol><li>When the link title is not set, the link will display the title of the note. If the title of the note gets changed, the link will be renamed automatically to the new name.<ol><li>This is sometimes also called \"reference link\".</li><li>The icon of the linked note will also be displayed.</li><li>If the linked note is deleted, the link keeps the last title it showed, in red and with a <span class=\"tn-icon bx bx-x\"></span> icon instead of the note icon. Clicking it while editing opens the <em>Fix link</em> dialog, which searches for that title; picking a note, or creating a new one, replaces the link with one to that note.</li></ol></li><li>When a link title is typed, the link shows that text instead.<ol><li>This will create a traditional hyperlink, where the text of the link can be different from the note title.</li></ol></li></ol><p>Since v0.107.0, to change a link, click it and press the <span class=\"tn-icon cke cke-pencil\"></span> <em>Edit link</em> button in its popup. For a link with a title of its own, placing the cursor inside it and pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the <span class=\"tn-icon cke cke-trilium\"></span> button works too. The <em>Edit link</em> dialog opens on the linked note, with its anchor and, for a link with a title of its own, the link's text; <em>Save link</em> changes the whole link. Emptying the <em>Link title</em> there turns the link into one that displays the title of the note, and typing one gives it a title of its own.</p><h2>In-place linking</h2><p>You can also insert internal links “inline” by using the <code>@</code> symbol:</p><ol><li>Type <code>@</code> in a text note, which will open the note search menu.</li><li>Search for the desired note's title by typing a few characters. Use <kbd>Up</kbd> and <kbd>Down</kbd> to select the correct note, and press <kbd>Enter</kbd> or <kbd>Tab</kbd> to create the link. It's also possible to create new notes with this method by typing a non-existing note title and selecting <em>Create note</em>, as described above, or <em>Create child note</em>. <em>Create child note</em> creates the note under the note being edited without asking for its type, inserts the link and opens the new note in <a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>, which offers the note types to turn it into while it is still empty.</li></ol><p>To create an empty child note and link to it before naming it, use <em>New child note</em>, described in <a class=\"reference-link\" href=\"#root/_help_CohkqWQC1iBv\">Insert buttons</a>.</p><h2>Pasting internal links</h2><p>You can also insert internal links by copying a note from the note tree.</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, select a note and press <kbd>Ctrl</kbd> + <kbd>C</kbd>.</li><li>In a text note, paste the link by pressing <kbd>Ctrl</kbd> + <kbd>V</kbd>.</li></ol>",
diff --git a/docs/User Guide/User Guide/Note Types/Text/Link Previews.md b/docs/User Guide/User Guide/Note Types/Text/Link Previews.md
index 7a0acda8e2..dd330367b4 100644
--- a/docs/User Guide/User Guide/Note Types/Text/Link Previews.md
+++ b/docs/User Guide/User Guide/Note Types/Text/Link Previews.md
@@ -65,7 +65,7 @@ To turn an existing link into a preview, open its _Edit link_ dialog and change
### 3\. From the Insert menu, for a YouTube video
-Choose <span class="tn-icon bx bxl-youtube"></span> _YouTube video_ from the <a class="reference-link" href="Insert%20buttons.md">Insert buttons</a> menu, or _Insert YouTube video_ from the <a class="reference-link" href="Slash%20Commands.md">Slash Commands</a>. Paste the address of the video and press _Insert video_ or <kbd>Enter</kbd> to insert it as an _Embed_.
+Choose <span class="tn-icon bx bxl-youtube"></span> _YouTube video_ from the <a class="reference-link" href="Insert%20buttons.md">Insert buttons</a> menu, or _Insert YouTube video_ from the <a class="reference-link" href="Slash%20Commands.md">Slash Commands</a>. Paste the address of the video and press _Insert video_ or <kbd>Enter</kbd> to insert it as an _Embed_. The video is inserted once its title and thumbnail have loaded, which can take a few seconds. When they cannot be loaded, an error is shown and the prompt stays open.
### 4\. By saving browser tabs from the Web Clipper
diff --git a/packages/ckeditor5/src/plugins/link_embed/link_embed_commands.ts b/packages/ckeditor5/src/plugins/link_embed/link_embed_commands.ts
index 614d7b4be2..32be497157 100644
--- a/packages/ckeditor5/src/plugins/link_embed/link_embed_commands.ts
+++ b/packages/ckeditor5/src/plugins/link_embed/link_embed_commands.ts
@@ -65,6 +65,24 @@ export function getMetadataAttributes(metadata: LinkEmbedMetadata): Record<strin
return Object.fromEntries(META_KEYS.map((key) => [ key, metadata[key] ]));
}
+/**
+ * The model attributes of a preview of the `mode` shape of the page at `href`, made from its
+ * fetched `metadata`. `title` and `description` replace the page's own.
+ */
+export function getPreviewAttributes(
+ editor: Editor, mode: Exclude<LinkDisplayMode, 'plain'>, href: string,
+ metadata: LinkEmbedMetadata, title?: string, description?: string
+): Record<string, unknown> {
+ return {
+ ...getMetadataAttributes(metadata),
+ embedType: mode === 'embed'
+ ? getLinkEmbedHost(editor).detectEmbedType(href)
+ : metadata.embedType,
+ title: title || metadata.title,
+ description: description || metadata.description
+ };
+}
+
/**
* Puts a link to `url` at the selection, or in place of the link or the link preview the selection
* is in, and turns it into a preview of the `mode` shape once the page's metadata arrives. `title`
@@ -285,14 +303,8 @@ async function replaceLinkWithPreview(
}
if (!linkStillThere) return;
- const element = createLinkPreview(writer, mode, {
- ...getMetadataAttributes(metadata),
- embedType: mode === 'embed'
- ? getLinkEmbedHost(editor).detectEmbedType(href)
- : metadata.embedType,
- title: title || metadata.title,
- description: description || metadata.description
- });
+ const element = createLinkPreview(writer, mode,
+ getPreviewAttributes(editor, mode, href, metadata, title, description));
model.insertContent(element, currentRange);
// The widget toolbar, with its Display dropdown, takes over from the link balloon.
diff --git a/packages/ckeditor5/src/plugins/youtube_video.spec.ts b/packages/ckeditor5/src/plugins/youtube_video.spec.ts
index cce45bf890..642bc41792 100644
--- a/packages/ckeditor5/src/plugins/youtube_video.spec.ts
+++ b/packages/ckeditor5/src/plugins/youtube_video.spec.ts
@@ -1,12 +1,13 @@
import {
- _setModelData as setModelData, ButtonView, type ClassicEditor, CodeBlock, ContextualBalloon,
- Essentials, LinkEditing, Paragraph
+ _getModelData as getModelData, _setModelData as setModelData, ButtonView, type ClassicEditor,
+ CodeBlock, ContextualBalloon, Essentials, LinkEditing, type ModelRootElement, type ModelWriter,
+ Paragraph
} from "ckeditor5";
import { beforeEach, describe, expect, it, type Mock, vi } from "vitest";
import { createTestEditor } from "../../test/editor-kit.js";
import {
- createLinkEmbedHost, findElement, type LinkEmbedHostMocks
+ createLinkEmbedHost, findElement, flushFetch, type LinkEmbedHostMocks, META, useDeferredFetch
} from "../../test/link-embed-kit.js";
import YouTubeVideoPlugin, { COMMAND_NAME, type YouTubeVideoRequest } from "./youtube_video.js";
@@ -31,6 +32,12 @@ describe("YouTubeVideoPlugin", () => {
return editor.plugins.get(ContextualBalloon);
}
+ function getRoot() {
+ const root = editor.model.document.getRoot();
+ if (!root) throw new Error("The editor has no root.");
+ return root;
+ }
+
it("opens the prompt from a button bound to the command", () => {
const button = editor.ui.componentFactory.create(COMMAND_NAME);
if (!(button instanceof ButtonView)) {
@@ -51,20 +58,77 @@ describe("YouTubeVideoPlugin", () => {
expect(button.isEnabled).toBe(false);
});
- it("inserts a player of the video given, and closes the balloon", async () => {
+ /** Opens the prompt, and returns the request the host gets. */
+ function openPrompt() {
editor.execute(COMMAND_NAME);
+ const request = showPrompt.mock.lastCall?.[0];
+ if (!request) throw new Error("The prompt did not open.");
+ return request;
+ }
+
+ /** The model data, with each player shortened to `<video/>`. */
+ function getData() {
+ return getModelData(editor.model)
+ .replace(/<contentEmbed [^>]*><\/contentEmbed>/g, "<video/>");
+ }
+
+ it("inserts nothing while the video loads, then its player, and closes the balloon", async () => {
+ const { resolveFetch } = useDeferredFetch(linkEmbed.fetchMetadata);
- showPrompt.mock.calls[0][0].onInsert(VIDEO_URL);
+ const inserted = openPrompt().onInsert(VIDEO_URL);
+ await flushFetch();
+ expect(getData()).toBe("<paragraph>[]</paragraph>");
+ expect(release).not.toHaveBeenCalled();
+ expect(balloon().visibleView).not.toBeNull();
+ resolveFetch({ ...META, url: VIDEO_URL });
+ await inserted;
expect(release).toHaveBeenCalledOnce();
expect(balloon().visibleView).toBeNull();
- await vi.waitFor(() => expect(findElement(editor, "contentEmbed")).toBeDefined());
+ expect(getData()).toBe("[<video/>]");
const embed = findElement(editor, "contentEmbed");
expect(embed?.getAttribute("url")).toBe(VIDEO_URL);
expect(embed?.getAttribute("embedType")).toBe("youtube");
expect(linkEmbed.fetchMetadata).toHaveBeenCalledExactlyOnceWith(VIDEO_URL);
});
+ it("rejects, inserting nothing and keeping the balloon, for a video it cannot load", async () => {
+ linkEmbed.fetchMetadata.mockResolvedValue({ url: VIDEO_URL, unresolved: true });
+ const { onInsert } = openPrompt();
+
+ await expect(onInsert(VIDEO_URL)).rejects.toThrow();
+ linkEmbed.fetchMetadata.mockRejectedValue(new Error("Offline"));
+ await expect(onInsert(VIDEO_URL)).rejects.toThrow("Offline");
+
+ expect(getData()).toBe("<paragraph>[]</paragraph>");
+ expect(release).not.toHaveBeenCalled();
+ expect(balloon().visibleView).not.toBeNull();
+ });
+
+ it("inserts the video where the prompt opened, or at the selection once that is gone", async () => {
+ const { resolveFetch } = useDeferredFetch(linkEmbed.fetchMetadata);
+ const insertAfter = async (edit: (writer: ModelWriter, root: ModelRootElement) => void) => {
+ setModelData(editor.model,
+ "<paragraph>one</paragraph><paragraph>[]</paragraph><paragraph>two</paragraph>");
+ const inserted = openPrompt().onInsert(VIDEO_URL);
+ await flushFetch();
+ editor.model.change((writer) => edit(writer, getRoot()));
+ resolveFetch({ ...META, url: VIDEO_URL });
+ await inserted;
+ return getData();
+ };
+
+ expect(await insertAfter((writer, root) => {
+ writer.insertElement("paragraph", root, 0);
+ })).toBe("<paragraph></paragraph><paragraph>one</paragraph>[<video/>]"
+ + "<paragraph>two</paragraph>");
+
+ expect(await insertAfter((writer, root) => {
+ writer.remove(root.getNodeByPath([ 1 ]));
+ writer.setSelection(root.getNodeByPath([ 1 ]), 0);
+ })).toBe("<paragraph>one</paragraph>[<video/>]<paragraph>two</paragraph>");
+ });
+
it("closes the balloon again for a host that shows the prompt its own way", () => {
showPrompt.mockReturnValue(null);
diff --git a/packages/ckeditor5/src/plugins/youtube_video.ts b/packages/ckeditor5/src/plugins/youtube_video.ts
index fd00d7f40a..582e044985 100644
--- a/packages/ckeditor5/src/plugins/youtube_video.ts
+++ b/packages/ckeditor5/src/plugins/youtube_video.ts
@@ -1,15 +1,17 @@
import youtubeIcon from "boxicons/svg/logos/bxl-youtube.svg?raw";
-import { ButtonView, Command, ContextualBalloon, Plugin } from "ckeditor5";
+import { ButtonView, Command, ContextualBalloon, type Editor, ModelLiveRange, Plugin } from "ckeditor5";
import HostedBalloon from "../hosted_balloon.js";
-import { LINK_EMBED_COMMAND } from "./link_embed/link_embed_commands.js";
+import {
+ createLinkPreview, getLinkEmbedHost, getPreviewAttributes
+} from "./link_embed/link_embed_commands.js";
import LinkEmbedEditing from "./link_embed/link_embed_editing.js";
export const COMMAND_NAME = "youtubeVideo";
/**
- * The "YouTube video" button: asks for the address of a video, then inserts a link preview of it
- * in the embed display mode.
+ * The "YouTube video" button: asks for the address of a video, then inserts a player of it, the
+ * link preview of the embed display mode, once its metadata and thumbnail are ready.
*/
export default class YouTubeVideoPlugin extends Plugin {
@@ -59,15 +61,47 @@ export default class YouTubeVideoPlugin extends Plugin {
this.prompt.show((container) => editor.config.get("youtubeVideo")?.showPrompt({
container,
- onInsert: (url) => {
+ onInsert: async (url) => {
+ await insertVideo(editor, url);
this.prompt.hide();
editor.editing.view.focus();
- void editor.execute(LINK_EMBED_COMMAND, { url, mode: "embed" });
}
}) ?? null);
}
}
+/**
+ * Inserts a player of the YouTube video at `url` at the selection, once the video's metadata has
+ * arrived, and selects it. Rejects, inserting nothing, when the metadata cannot be read.
+ */
+async function insertVideo(editor: Editor, url: string) {
+ const model = editor.model;
+ const range = model.document.selection.getFirstRange();
+ /* v8 ignore next 3 -- the command is enabled only with a selection */
+ if (!range) {
+ throw new Error("There is no selection to insert the video at.");
+ }
+
+ // Tracked while the metadata arrives, so that edits made meanwhile do not shift it.
+ const place = ModelLiveRange.fromRange(range);
+ try {
+ const metadata = await getLinkEmbedHost(editor).fetchMetadata(url);
+ if (metadata.unresolved) {
+ throw new Error("The metadata of the video could not be read.");
+ }
+
+ model.change((writer) => {
+ const video = createLinkPreview(writer, "embed",
+ getPreviewAttributes(editor, "embed", url, metadata));
+ const isRemoved = place.root === model.document.graveyard;
+ model.insertContent(video, isRemoved ? model.document.selection : place.toRange());
+ writer.setSelection(video, "on");
+ });
+ } finally {
+ place.detach();
+ }
+}
+
/** Enabled wherever an embed can go, with a host to ask for the address. */
class YouTubeVideoCommand extends Command {
@@ -90,8 +124,12 @@ class YouTubeVideoCommand extends Command {
export interface YouTubeVideoRequest {
/** The element to render the prompt into, which the editor owns and places at the caret. */
container: HTMLElement;
- /** Closes the balloon and inserts a player of the YouTube video at `url`. */
- onInsert(url: string): void;
+ /**
+ * Inserts a player of the YouTube video at `url` once its metadata and thumbnail are ready,
+ * then closes the balloon. Rejects, inserting nothing and leaving the balloon open, when they
+ * cannot be loaded.
+ */
+ onInsert(url: string): Promise<void>;
}
declare module "ckeditor5" {