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: tweak the entries from the "Insert" dropdown
Adorian Doran89a4d7f58c20
diff --git a/apps/client/src/translations/en/translation.json b/apps/client/src/translations/en/translation.jsonindex 3c374854f4..2e68efc5b3 100644--- a/apps/client/src/translations/en/translation.json+++ b/apps/client/src/translations/en/translation.json@@ -4401,6 +4401,8 @@"insert-titled-tabs-that-show-one-panel-at-a-time": "Insert titled tabs that show one panel at a time.","multicolumn-layout": "Multicolumn layout","multicolumn-layout-toolbar": "Multicolumn layout toolbar",+ "multiple-column-layout": "Multiple column layout",+ "0-columns": "%0 columns","column-layout": "Column layout","0-columns-layout": "%0 columns layout","arrange-content-in-0-equal-columns-side-by-side": "Arrange content in %0 equal columns side by side.",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 a964804e9c..72f9b58893 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@@ -6,8 +6,8 @@have no borders, and their text lines up with the rest of the note.</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> to- insert a layout with two columns.</li>+ <li>In the formatting bar, go to <em>Insert</em> → <span class="tn-icon cke cke-trilium-multicolumn"></span> <em>Multiple column layout</em> to+ insert a layout with two columns. Its submenu offers <em>2 columns</em>, <em>3 columns</em> and <em>4 columns</em>.</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>diff --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 ccdd6d117b..078f4e9fbc 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@@ -5,7 +5,7 @@ The borders around the columns are only a guide while editing. In [read-only not## Inserting a layout-* 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.+* In the formatting bar, go to _Insert_ → <span class="tn-icon cke cke-trilium-multicolumn"></span> _Multiple column layout_ to insert a layout with two columns. Its submenu offers _2 columns_, _3 columns_ and _4 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>.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.diff --git a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.spec.ts b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.spec.tsindex a98740ceba..84ac3dfd30 100644--- a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.spec.ts+++ b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.spec.ts@@ -4,11 +4,13 @@ import {type ButtonView,type ClassicEditor,ContextualBalloon,- type DropdownView,+ DropdownView,Essentials,IconCancel,+ type ListItemView,type ModelElement,Paragraph,+ SplitButtonView,type ToolbarView,type ViewDocumentSelection,type ViewElement,@@ -19,6 +21,10 @@ import { beforeEach, describe, expect, it, onTestFinished, vi } from "vitest";import { createTestEditor } from "../../../test/editor-kit.js";import multicolumnIcon from "../../icons/multicolumn.svg?raw";import type TileRowView from "../tile_row_view.js";+import ToolbarGroupMenu, {+ type ToolbarGroupMenuEntry, type ToolbarGroupMenuHost, type ToolbarGroupMenuItem,+ type ToolbarGroupMenuRequest+} from "../toolbar_group_menu.js";import { COLUMN_RATIOS } from "./constants.js";import Multicolumn from "./multicolumn.js";import { createLayoutFigure, formatRatios } from "./multicolumn_ui.js";@@ -37,6 +43,13 @@ function layout(ratios: string, ...columns: string[]) {return `<multicolumnLayout columnRatios="${ratios}">${content.join("")}</multicolumnLayout>`;}+function entryOf(item: ToolbarGroupMenuItem | undefined): ToolbarGroupMenuEntry {+ if (item?.kind !== "entry") {+ throw new Error("expected a menu entry");+ }+ return item;+}+describe("MulticolumnUI", () => {let editor: ClassicEditor;@@ -44,21 +57,99 @@ describe("MulticolumnUI", () => {editor = await createTestEditor([Essentials, Paragraph, Multicolumn]);});- it("inserts a layout from its button and returns the focus to the editor", () => {- setModelData(editor.model, "<paragraph>[]</paragraph>");- const button = editor.ui.componentFactory.create("multicolumnLayout") as ButtonView;- expect(button.label).toBe("Multicolumn layout");- expect(button.icon && button.tooltip).toBeTruthy();- expect(button.isEnabled).toBe(true);- const focus = vi.spyOn(editor.editing.view, "focus");+ describe("insert button", () => {+ function createInsertDropdown() {+ const dropdown = editor.ui.componentFactory.create("multicolumnLayout") as DropdownView;+ dropdown.render();+ const element = dropdown.element as HTMLElement;+ document.body.appendChild(element);+ onTestFinished(() => element.remove());+ dropdown.isOpen = true;+ return dropdown;+ }- button.fire("execute");+ function itemsOf(dropdown: DropdownView) {+ return [...dropdown.listView?.items ?? []]+ .map(item => (item as ListItemView).children.first as ButtonView);+ }- expect(getModelData(editor.model)).toContain("<multicolumnLayout");- expect(focus).toHaveBeenCalled();+ it("inserts two columns from its main action and returns the focus to the editor", () => {+ setModelData(editor.model, "<paragraph>[]</paragraph>");+ const dropdown = createInsertDropdown();+ const button = dropdown.buttonView;+ expect(button).toBeInstanceOf(SplitButtonView);+ expect([button.label, button.icon, button.tooltip])+ .toEqual(["Multiple column layout", multicolumnIcon, true]);+ expect(dropdown.isEnabled).toBe(true);+ const focus = vi.spyOn(editor.editing.view, "focus");- editor.enableReadOnlyMode("spec");- expect(button.isEnabled).toBe(false);+ button.fire("execute");++ expect(getModelData(editor.model, { withoutSelection: true }))+ .toBe(layout("1-1", paragraph(""), paragraph("")));+ expect(focus).toHaveBeenCalled();++ editor.enableReadOnlyMode("spec");+ expect([dropdown.isEnabled, button.isEnabled]).toEqual([false, false]);+ });++ it("lists 2, 3 and 4 columns, each inserting that many equal columns", () => {+ const dropdown = createInsertDropdown();+ const items = itemsOf(dropdown);+ const focus = vi.spyOn(editor.editing.view, "focus");++ expect(items.map(item => [item.label, item.icon])).toEqual([+ ["2 columns", createLayoutFigure("1-1", 20)],+ ["3 columns", createLayoutFigure("1-1-1", 20)],+ ["4 columns", createLayoutFigure("1-1-1-1", 20)]+ ]);+ for (const [index, ratios] of ["1-1", "1-1-1", "1-1-1-1"].entries()) {+ setModelData(editor.model, "<paragraph>[]</paragraph>");+ items[index].fire("execute");++ const columns = ratios.split("-").map(() => paragraph(""));+ expect(getModelData(editor.model, { withoutSelection: true }))+ .toBe(layout(ratios, ...columns));+ }+ expect(focus).toHaveBeenCalledTimes(3);+ });++ it("is a split entry of a menu group, over its three column counts", async () => {+ const host = { show: vi.fn(), hide: vi.fn(), destroy: vi.fn() } satisfies+ ToolbarGroupMenuHost;+ const group = {+ label: "Insert", icon: "plus", asMenu: true, items: ["multicolumnLayout"]+ };+ const menuEditor = await createTestEditor(+ [Essentials, Paragraph, Multicolumn, ToolbarGroupMenu],+ { toolbarGroupMenu: { host: () => host }, toolbar: { items: [group] } }+ );+ const toolbar = (menuEditor.ui.view as { toolbar: ToolbarView }).toolbar;+ const dropdown = [...toolbar.items].find(item => item instanceof DropdownView);++ /** Opens the group and returns the menu entry of the layout. */+ function openEntry() {+ expect(dropdown).toBeInstanceOf(DropdownView);+ (dropdown as DropdownView).isOpen = true;+ const request = host.show.mock.lastCall?.[0] as ToolbarGroupMenuRequest | undefined;+ return entryOf(request?.items[0]);+ }++ setModelData(menuEditor.model, "<paragraph>[]</paragraph>");+ const entry = openEntry();+ expect(entry.label).toBe("Multiple column layout");+ expect(entry.children?.map(child => entryOf(child).label))+ .toEqual(["2 columns", "3 columns", "4 columns"]);++ entry.run?.();+ expect(getModelData(menuEditor.model, { withoutSelection: true }))+ .toBe(layout("1-1", paragraph(""), paragraph("")));++ setModelData(menuEditor.model, "<paragraph>[]</paragraph>");+ entryOf(openEntry().children?.[2]).run?.();+ expect(getModelData(menuEditor.model, { withoutSelection: true }))+ .toBe(layout("1-1-1-1", ...Array.from({ length: 4 }, () => paragraph(""))));+ });});it("removes the layout from its button, keeping the content", () => {diff --git a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.ts b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.tsindex 6906ea9ceb..d576738acf 100644--- a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.ts+++ b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_ui.ts@@ -1,23 +1,31 @@import {+ addListToDropdown,ButtonView,+ Collection,type Command,createDropdown,focusChildOnDropdownOpen,IconCancel,+ type ListDropdownItemDefinition,type Locale,Plugin,+ SplitButtonView,+ ViewModel,WidgetToolbarRepository} from "ckeditor5";import multicolumnIcon from "../../icons/multicolumn.svg?raw";import TileRowView from "../tile_row_view.js";import { findSelectedWidget } from "../widget_utils.js";-import { COLUMN_RATIOS, getColumnCount, LAYOUT_WIDGET_PROPERTY } from "./constants.js";+import {+ COLUMN_RATIOS, getColumnCount, getDefaultRatios, LAYOUT_WIDGET_PROPERTY, MAX_COLUMNS,+ MIN_COLUMNS+} from "./constants.js";import type { ColumnLayoutCommand } from "./multicolumn_commands.js";/**- * The insert button for multicolumn layouts, and the contextual toolbar with the column layout- * dropdown and the remove button, shown while the selection is inside a layout.+ * The insert split button for multicolumn layouts, and the contextual toolbar with the column+ * layout dropdown and the remove button, shown while the selection is inside a layout.*/export default class MulticolumnUI extends Plugin {@@ -32,7 +40,7 @@ export default class MulticolumnUI extends Plugin {public init(): void {const t = this.editor.t;const factory = this.editor.ui.componentFactory;- this.addCommandButton("multicolumnLayout", t("Multicolumn layout"), multicolumnIcon);+ factory.add("multicolumnLayout", locale => this.createInsertDropdown(locale));factory.add("columnLayout", locale => this.createLayoutDropdown(locale));this.addCommandButton("removeMulticolumnLayout", t("Remove layout"), IconCancel);}@@ -63,6 +71,48 @@ export default class MulticolumnUI extends Plugin {});}+ /**+ * A split button that inserts two equal columns, with a list that inserts two to four equal+ * columns.+ */+ private createInsertDropdown(locale: Locale) {+ const editor = this.editor;+ const command = editor.commands.get("multicolumnLayout") as Command;+ const dropdown = createDropdown(locale, SplitButtonView);+ dropdown.buttonView.set({+ label: editor.t("Multiple column layout"),+ icon: multicolumnIcon,+ tooltip: true+ });+ // `createDropdown` binds the split button's `isEnabled` to the dropdown's.+ dropdown.bind("isEnabled").to(command, "isEnabled");++ const items = new Collection<ListDropdownItemDefinition>();+ for (let count = MIN_COLUMNS; count <= MAX_COLUMNS; count++) {+ const ratios = getDefaultRatios(count);+ items.add({+ type: "button",+ model: new ViewModel({+ commandParam: ratios,+ label: editor.t("%0 columns", count),+ icon: createLayoutFigure(ratios, BUTTON_ICON_SIZE),+ role: "menuitem",+ withText: true+ })+ });+ }+ addListToDropdown(dropdown, items);++ const insert = (value?: string) => {+ editor.execute("multicolumnLayout", { value });+ editor.editing.view.focus();+ };+ this.listenTo(dropdown.buttonView, "execute", () => insert());+ this.listenTo(dropdown, "execute", evt =>+ insert((evt.source as { commandParam?: string }).commandParam));+ return dropdown;+ }+/** A dropdown with a figure of every column layout, grouped by column count. */private createLayoutDropdown(locale: Locale) {const editor = this.editor;