Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
feat(share): add a copy button to code blocks
Elian Doran1c9be81955cb
diff --git a/apps/server/src/assets/translations/en/server.json b/apps/server/src/assets/translations/en/server.jsonindex b64f6eccdb..9a62f57bff 100644--- a/apps/server/src/assets/translations/en/server.json+++ b/apps/server/src/assets/translations/en/server.json@@ -477,7 +477,8 @@"next": "Next","page-navigation": "Previous and next pages","previous-tabs": "Scroll to the previous tabs",- "next-tabs": "Scroll to the next tabs"+ "next-tabs": "Scroll to the next tabs",+ "copy-code": "Copy code"},"hidden_subtree_templates": {"text-snippet": "Text Snippet",diff --git a/packages/share-theme/src/content/code_copy.spec.ts b/packages/share-theme/src/content/code_copy.spec.tsnew file mode 100644index 0000000000..a520b7a850--- /dev/null+++ b/packages/share-theme/src/content/code_copy.spec.ts@@ -0,0 +1,56 @@+// @vitest-environment happy-dom+import { afterEach, describe, expect, it, vi } from "vitest";++import setupCodeCopy from "./code_copy.js";++describe("setupCodeCopy", () => {+ afterEach(() => {+ document.body.innerHTML = "";+ vi.unstubAllGlobals();+ vi.useRealTimers();+ });++ it("adds a button to each code block that copies its code and shows a check mark for a moment", async () => {+ vi.useFakeTimers();+ const writeText = stubClipboard();+ document.body.innerHTML = `<div id="content" data-copy-code-label="Copy code">`+ + `<pre><code class="language-text-x-sh">npm install\npnpm build</code></pre>`+ + `<pre><code class="language-mermaid">graph TD; A-->B</code></pre>`+ + `<p><code>inline</code></p></div>`;++ setupCodeCopy();++ const buttons = document.querySelectorAll<HTMLButtonElement>("button.copy-button");+ // Neither a diagram, which Mermaid replaces, nor inline code gets a button.+ expect(buttons).toHaveLength(1);+ const [ button ] = buttons;+ expect(button.parentElement?.tagName).toBe("PRE");+ expect(button.type).toBe("button");+ expect(button.getAttribute("aria-label")).toBe("Copy code");+ expect(button.title).toBe("Copy code");++ button.click();+ await vi.waitFor(() => expect(writeText).toHaveBeenCalledWith("npm install\npnpm build"));+ expect(button.classList).toContain("copied");+ expect(button.querySelector(".tn-icon")?.classList).toContain("bx-check");++ vi.advanceTimersByTime(1500);+ expect(button.classList).not.toContain("copied");+ expect(button.querySelector(".tn-icon")?.classList).toContain("bx-copy");+ });++ it("adds no button where the page cannot write to the clipboard, such as over plain HTTP", () => {+ vi.stubGlobal("navigator", { ...navigator, clipboard: undefined });+ document.body.innerHTML = `<div id="content" data-copy-code-label="Copy code"><pre><code>x</code></pre></div>`;++ setupCodeCopy();++ expect(document.querySelector("button.copy-button")).toBeNull();+ });+});++function stubClipboard() {+ const writeText = vi.fn(async () => undefined);+ vi.stubGlobal("navigator", { ...navigator, clipboard: { writeText } });+ return writeText;+}diff --git a/packages/share-theme/src/content/code_copy.ts b/packages/share-theme/src/content/code_copy.tsnew file mode 100644index 0000000000..8ead569b1d--- /dev/null+++ b/packages/share-theme/src/content/code_copy.ts@@ -0,0 +1,49 @@+/** How long a copy button shows its check mark after copying, in milliseconds. */+const COPIED_DURATION = 1500;++/**+ * Adds a button to each code block of the content that copies its code, showing a check mark for+ * a moment. Mermaid blocks, which `setupMermaid()` replaces with diagrams, get none. Without+ * `navigator.clipboard`, which browsers expose only in secure contexts, no block gets one.+ */+export default function setupCodeCopy() {+ const content = document.getElementById("content");+ if (!content || !navigator.clipboard) {+ return;+ }++ const label = content.dataset.copyCodeLabel ?? "";+ for (const code of content.querySelectorAll<HTMLElement>("pre > code:not(.language-mermaid)")) {+ code.parentElement?.append(createCopyButton(code, label));+ }+}++function createCopyButton(code: HTMLElement, label: string) {+ const button = document.createElement("button");+ button.type = "button";+ button.className = "copy-button";+ button.title = label;+ button.setAttribute("aria-label", label);++ const icon = document.createElement("span");+ icon.className = "tn-icon bx bx-copy";+ icon.setAttribute("aria-hidden", "true");+ button.append(icon);++ let resetTimer: ReturnType<typeof setTimeout> | undefined;+ const setCopied = (copied: boolean) => {+ button.classList.toggle("copied", copied);+ icon.classList.toggle("bx-copy", !copied);+ icon.classList.toggle("bx-check", copied);+ };++ button.addEventListener("click", () => {+ navigator.clipboard.writeText(code.textContent ?? "").then(() => {+ setCopied(true);+ clearTimeout(resetTimer);+ resetTimer = setTimeout(() => setCopied(false), COPIED_DURATION);+ }, () => undefined);+ });++ return button;+}diff --git a/packages/share-theme/src/content/content.css b/packages/share-theme/src/content/content.cssindex 65adec495a..752a7f5468 100644--- a/packages/share-theme/src/content/content.css+++ b/packages/share-theme/src/content/content.css@@ -58,10 +58,53 @@ iframe.pdf-view {overflow: auto;}-.ck-content pre .copy-button {+.ck-content pre:has(> .copy-button) {+ position: relative;++ & > code {+ padding-inline-end: 3em;+ }+}++.ck-content pre > .copy-button {position: absolute;top: 0.5em;- right: 0.5em;+ inset-inline-end: 0.5em;+ display: flex;+ align-items: center;+ justify-content: center;+ width: 2em;+ height: 2em;+ border: 0;+ border-radius: 6px;+ padding: 0;+ background: transparent;+ color: var(--text-menu);+ font-size: 1rem;+ cursor: pointer;+ opacity: 0;+ transition: opacity 150ms ease;++ & > .tn-icon {+ font-size: 1.25em;+ }++ &:hover {+ background: var(--background-highlight);+ color: var(--text-primary);+ }+}++.ck-content pre:hover > .copy-button,+.ck-content pre > .copy-button:focus-visible,+.ck-content pre > .copy-button.copied {+ opacity: 1;+}++@media (hover: none) {+ .ck-content pre > .copy-button {+ opacity: 0.6;+ }}/* The heading weight of the app's default theme (`theme-next/notes/text.css`), and the sizes anddiff --git a/packages/share-theme/src/index.ts b/packages/share-theme/src/index.tsindex a8e7d4e709..e819649274 100644--- a/packages/share-theme/src/index.ts+++ b/packages/share-theme/src/index.ts@@ -18,6 +18,7 @@ import "./content/adaptive_colors.css";import "./content/link_embed.css";import "./content/full_height.css";import "./content/app_view.css";+import setupCodeCopy from "./content/code_copy.js";import setupMath from "./content/math.js";import setupAppView from "./content/app_view.js";import setupMermaid from "./content/mermaid.js";@@ -77,6 +78,7 @@ $try(setupSpeculation);function setupTextNote() {const diagrams = $try(setupMermaid);$try(setupMath);+ $try(setupCodeCopy);$try(() => enhanceLinkPreviews(document.body));$try(setupTableScroll);$try(setupStickyTableHeaders);diff --git a/packages/share-theme/src/templates/page.ejs b/packages/share-theme/src/templates/page.ejsindex 3713c2e09a..ea33a1480f 100644--- a/packages/share-theme/src/templates/page.ejs+++ b/packages/share-theme/src/templates/page.ejs@@ -71,7 +71,7 @@</div><div id="right-pane"><div id="main">- <div id="content" class="<%= contentClasses %>"<% if (language.content) { %> lang="<%= language.content.lang %>" dir="<%= language.content.dir %>"<% } %> data-tab-title-placeholder="<%= t("share_theme.tab-title") %>" data-tab-previous-label="<%= t("share_theme.previous-tabs") %>" data-tab-next-label="<%= t("share_theme.next-tabs") %>">+ <div id="content" class="<%= contentClasses %>"<% if (language.content) { %> lang="<%= language.content.lang %>" dir="<%= language.content.dir %>"<% } %> data-tab-title-placeholder="<%= t("share_theme.tab-title") %>" data-tab-previous-label="<%= t("share_theme.previous-tabs") %>" data-tab-next-label="<%= t("share_theme.next-tabs") %>" data-copy-code-label="<%= t("share_theme.copy-code") %>"><%- snippets["content:start"] %><% if (showTitle && titleIcon) { %><div id="title-row">