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
client/text editor/multicolumn layout: extend to multiple slash command entries
Adorian Dorancb63a964a2ce
diff --git a/apps/client/src/translations/en/translation.json b/apps/client/src/translations/en/translation.jsonindex e79a3044c9..aacc3f53dc 100644--- a/apps/client/src/translations/en/translation.json+++ b/apps/client/src/translations/en/translation.json@@ -4394,7 +4394,8 @@"multicolumn-layout": "Multicolumn layout","multicolumn-layout-toolbar": "Multicolumn layout toolbar","column-layout": "Column layout",- "arrange-content-in-two-to-four-columns-side-by-side": "Arrange content in two to four columns side by side.",+ "0-columns-layout": "%0 columns layout",+ "arrange-content-in-0-equal-columns-side-by-side": "Arrange content in %0 equal columns side by side.","0-columns-1": "%0 columns (%1)","remove-layout": "Remove layout"},diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Multicolumn layout.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Multicolumn layout.htmlindex 6336b5b3d8..7fab86b03c 100644--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Multicolumn layout.html+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Multicolumn layout.html@@ -3,11 +3,12 @@another multicolumn layout.</p><h2>Inserting a layout</h2><ul>- <li>In the formatting bar, go to <em>Insert</em> → <span class="tn-icon cke cke-trilium-multicolumn"></span> <em>Multicolumn layout</em>.</li>- <li>Alternatively, type <code>/columns</code> and press <kbd>Enter</kbd>, as- described in <a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a>.</li>+ <li>In the formatting bar, go to <em>Insert</em> → <span class="tn-icon cke cke-trilium-multicolumn"></span> <em>Multicolumn layout</em> to+ insert a layout with two columns.</li>+ <li>Alternatively, type <code>/columns</code> and choose <em>2 columns layout</em>, <em>3 columns layout</em> or <em>4 columns layout</em>,+ as described in <a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a>.</li></ul>-<p>A new layout has two columns of equal width. If text is selected when+<p>The columns of a new layout have equal widths. If text is selected whenthe layout is inserted, the selection moves into the first column.</p><h2>Changing the columns</h2><p>While the cursor is inside a layout, a toolbar appears above it with adiff --git a/docs/User Guide/User Guide/Note Types/Text/Multicolumn layout.md b/docs/User Guide/User Guide/Note Types/Text/Multicolumn layout.mdindex 2a91bf74a5..f968103a7c 100644--- a/docs/User Guide/User Guide/Note Types/Text/Multicolumn layout.md+++ b/docs/User Guide/User Guide/Note Types/Text/Multicolumn layout.md@@ -3,10 +3,10 @@ A multicolumn layout arranges content in two to four columns, side by side. A co## Inserting a layout-* In the formatting bar, go to _Insert_ → <span class="tn-icon cke cke-trilium-multicolumn"></span> _Multicolumn layout_.-* Alternatively, type `/columns` and press <kbd>Enter</kbd>, as described in <a class="reference-link" href="Slash%20Commands.md">Slash Commands</a>.+* In the formatting bar, go to _Insert_ → <span class="tn-icon cke cke-trilium-multicolumn"></span> _Multicolumn layout_ to insert a layout with two columns.+* Alternatively, type `/columns` and choose _2 columns layout_, _3 columns layout_ or _4 columns layout_, as described in <a class="reference-link" href="Slash%20Commands.md">Slash Commands</a>.-A new layout has two columns of equal width. If text is selected when the layout is inserted, the selection moves into the first column.+The columns of a new layout have equal widths. If text is selected when the layout is inserted, the selection moves into the first column.## Changing the columnsdiff --git a/packages/ckeditor5/src/plugins/mention/slash_commands.spec.ts b/packages/ckeditor5/src/plugins/mention/slash_commands.spec.tsindex 0588d997ce..aad6ac442a 100644--- a/packages/ckeditor5/src/plugins/mention/slash_commands.spec.ts+++ b/packages/ckeditor5/src/plugins/mention/slash_commands.spec.ts@@ -26,6 +26,7 @@ import { COMMAND_NAME as INTERNAL_LINK_COMMAND } from "../internallink.js";import { COMMAND_NAME as MARKDOWN_IMPORT_COMMAND } from "../markdownimport.js";import MathUI from "../math/math_ui.js";import { INSERT_MERMAID_COMMAND } from "../mermaid/insert_mermaid_command.js";+import { BUTTON_ICON_SIZE, createLayoutFigure } from "../multicolumn/multicolumn_ui.js";import TriliumSnippets from "../snippets/snippets.js";import type { SnippetDefinition } from "../snippets/snippetsconfig.js";import TriliumSlashCommands, {@@ -782,6 +783,37 @@ describe("buildTriliumSlashCommands", () => {}});+ it("defines one multicolumn entry per column count, each inserting equal columns", () => {+ const { fake, executeSpy } = makeFakeEditor();++ const layouts = [ [ 2, "1-1" ], [ 3, "1-1-1" ], [ 4, "1-1-1-1" ] ] as const;+ for (const [ count, value ] of layouts) {+ const entry = definition(`multicolumn-layout-${count}`);+ expect(entry.title).toBe(`${count} columns layout`);+ expect(entry.description)+ .toBe(`Arrange content in ${count} equal columns side by side.`);+ expect(entry.commandName).toBe("multicolumnLayout");+ expect(entry.icon).toBe(createLayoutFigure(value, BUTTON_ICON_SIZE));++ entry.execute?.(fake);+ expect(executeSpy).toHaveBeenLastCalledWith("multicolumnLayout", { value });+ }+ });++ it("finds the multicolumn entries by the feature's name, fewest columns first", () => {+ const definitions = buildTriliumSlashCommands(editor);+ const layouts = (query: string) => matchSlashCommands(definitions, query)+ .map((entry) => entry.id)+ .filter((id) => id.startsWith("multicolumn"));++ const all = [ "multicolumn-layout-2", "multicolumn-layout-3", "multicolumn-layout-4" ];++ for (const query of [ "multicolumn", "columns", "layout", "side by side" ]) {+ expect(layouts(query)).toEqual(all);+ }+ expect(matchSlashCommands(definitions, "3")[0]?.id).toBe("multicolumn-layout-3");+ });+it("opens the math balloon rather than running a command", () => {const { fake, pluginInstances } = makeFakeEditor();const showUI = vi.fn();diff --git a/packages/ckeditor5/src/plugins/mention/slash_commands.ts b/packages/ckeditor5/src/plugins/mention/slash_commands.tsindex 25578e9d06..c865fdbfbc 100644--- a/packages/ckeditor5/src/plugins/mention/slash_commands.ts+++ b/packages/ckeditor5/src/plugins/mention/slash_commands.ts@@ -39,7 +39,6 @@ import dateTimeIcon from "../../icons/date-time.svg?raw";import insertFootnoteIcon from "../../icons/insert-footnote.svg?raw";import importMarkdownIcon from "../../icons/markdown-mark.svg?raw";import mathIcon from "../../icons/math.svg?raw";-import multicolumnIcon from "../../icons/multicolumn.svg?raw";import noteIcon from "../../icons/note.svg?raw";import tabsIcon from "../../icons/tabs.svg?raw";import internalLinkIcon from "../../icons/trilium.svg?raw";@@ -56,6 +55,8 @@ import { COMMAND_NAME as MARKDOWN_IMPORT_COMMAND } from "../markdownimport.js";import MathUI from "../math/math_ui.js";import { INSERT_MERMAID_COMMAND } from "../mermaid/insert_mermaid_command.js";import type { MermaidSample } from "../mermaid/mermaid_ui.js";+import { getDefaultRatios, MAX_COLUMNS, MIN_COLUMNS } from "../multicolumn/constants.js";+import { BUTTON_ICON_SIZE, createLayoutFigure } from "../multicolumn/multicolumn_ui.js";import SnippetsEditing from "../snippets/snippetsediting.js";import { registerHostedMentionFeed } from "./register_feed.js";import type { MentionHostedList } from "./types.js";@@ -372,14 +373,7 @@ export function buildTriliumSlashCommands(editor: Editor): SlashCommandDefinitioicon: tabsIcon,commandName: "tabs"},- {- id: "multicolumn-layout",- title: t("Multicolumn layout"),- description: t("Arrange content in two to four columns side by side."),- aliases: [ "columns", "column", "layout", "side by side" ],- icon: multicolumnIcon,- commandName: "multicolumnLayout"- },+ ...buildMulticolumnSlashCommands(editor),{id: "footnote",title: t("Footnote"),@@ -675,6 +669,26 @@ function buildAdmonitionSlashCommands(editor: Editor): SlashCommandDefinition[]}));}+/** One entry per column count, inserting that many equal columns, with the layout as its icon. */+function buildMulticolumnSlashCommands(editor: Editor): SlashCommandDefinition[] {+ const t = editor.locale.t;++ return Array.from({ length: MAX_COLUMNS - MIN_COLUMNS + 1 }, (_, index) => {+ const count = MIN_COLUMNS + index;+ const value = getDefaultRatios(count);+ return {+ id: `multicolumn-layout-${count}`,+ title: t("%0 columns layout", count),+ description: t("Arrange content in %0 equal columns side by side.", count),+ aliases: [ "multicolumn", "columns", "column", "layout", "side by side" ],+ icon: createLayoutFigure(value, BUTTON_ICON_SIZE),+ // `commandName` supplies the enabled state; `execute` passes the column weights along.+ commandName: "multicolumnLayout",+ execute: (target: Editor) => target.execute("multicolumnLayout", { value })+ };+ });+}+/*** One palette entry per text snippet, restoring premium behaviour: premium `SlashCommand` listed the* premium `Template` plugin's definitions alongside the built-ins. Since `_catalog()` runs on everydiff --git a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_commands.spec.ts b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_commands.spec.tsindex d58b487b45..ecf9c000a3 100644--- a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_commands.spec.ts+++ b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_commands.spec.ts@@ -60,6 +60,24 @@ describe("multicolumn commands", () => {);});+ it("inserts the column weights it is given, and nothing for weights no layout uses", () => {+ setModelData(editor.model, "<paragraph>Keep [moved] text</paragraph>");+ editor.execute("multicolumnLayout", { value: "1-5" });+ expect(modelWithSelection()).toBe("<paragraph>Keep [moved] text</paragraph>");++ editor.execute("multicolumnLayout", { value: "1-2-1" });++ expect(modelWithSelection()).toBe(+ "<paragraph>Keep </paragraph>" ++ "<multicolumnLayout columnRatios=\"1-2-1\">" ++ "<multicolumnColumn><paragraph>moved[]</paragraph></multicolumnColumn>" ++ "<multicolumnColumn><paragraph></paragraph></multicolumnColumn>" ++ "<multicolumnColumn><paragraph></paragraph></multicolumnColumn>" ++ "</multicolumnLayout>" ++ "<paragraph> text</paragraph>"+ );+ });+it("moves selected blocks, lists and tables into the first column", () => {const listItem = "<paragraph listIndent=\"0\" listItemId=\"a\" listType=\"bulleted\">";const cell = "<tableCell><paragraph>Cell</paragraph></tableCell>";diff --git a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_commands.ts b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_commands.tsindex 9138f38ca8..3defeb4ef6 100644--- a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_commands.ts+++ b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_commands.ts@@ -5,8 +5,8 @@ import {} from "./constants.js";/**- * Inserts a layout with two equal columns at the selection. Selected content moves into the first- * column, and the caret goes to the end of that column.+ * Inserts a layout with the column weights `value`, two equal columns by default, at the selection.+ * Selected content moves into the first column, and the caret goes to the end of that column.*/export class InsertMulticolumnLayoutCommand extends Command {@@ -16,18 +16,22 @@ export class InsertMulticolumnLayoutCommand extends Command {this.isEnabled = !!position && !!model.schema.findAllowedParent(position, ELEMENTS.layout);}- public override execute(): void {+ public override execute(+ { value = getDefaultRatios(MIN_COLUMNS) }: { value?: string } = {}+ ): void {+ if (!COLUMN_RATIOS.includes(value)) {+ return;+ }+const model = this.editor.model;const selection = model.document.selection;model.change(writer => {const content = selection.isCollapsed ? null : model.getSelectedContent(selection);- const layout = writer.createElement(ELEMENTS.layout, {- [RATIOS_ATTRIBUTE]: getDefaultRatios(MIN_COLUMNS)- });+ const layout = writer.createElement(ELEMENTS.layout, { [RATIOS_ATTRIBUTE]: value });const firstColumn = createColumn(writer);writer.append(firstColumn, layout);- writer.append(createColumn(writer), layout);+ setColumnCount(writer, layout, getColumnCount(value));model.insertObject(layout);if (content) {diff --git a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.ts b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.tsindex ced8f6e848..6906ea9ceb 100644--- a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.ts+++ b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.ts@@ -138,7 +138,7 @@ export function createLayoutFigure(ratios: string, size: number): string {/** The icon sizes of a list style tile and of a toolbar button, in pixels. */const TILE_ICON_SIZE = 44;-const BUTTON_ICON_SIZE = 20;+export const BUTTON_ICON_SIZE = 20;function getShares(ratios: string) {const weights = ratios.split("-").map(Number);