Skip to content

Build your personal knowledge base with Trilium Notes

feat(mobile/text): show image positions as tiles

Elian Doranf853f7d62bcc
diff --git a/apps/client/src/widgets/type_widgets/text/toolbar_group_menu.spec.tsx b/apps/client/src/widgets/type_widgets/text/toolbar_group_menu.spec.tsx
index 61598f5a7d..ec1e341591 100644
--- a/apps/client/src/widgets/type_widgets/text/toolbar_group_menu.spec.tsx
+++ b/apps/client/src/widgets/type_widgets/text/toolbar_group_menu.spec.tsx
@@ -168,6 +168,25 @@ describe("createToolbarGroupMenuHost", () => {
expect(menu?.isConnected).toBe(false);
});
+ it("draws a heading over the tiles it starts, in the tiles layout", () => {
+ const items: ToolbarGroupMenuItem[] = [
+ { kind: "entry", label: "In line", icon: ICON, isEnabled: true },
+ { kind: "heading", label: "Break text" },
+ { kind: "entry", label: "Align left", icon: ICON, isEnabled: true },
+ { kind: "entry", label: "Align center", icon: ICON, isEnabled: true },
+ { kind: "heading", label: "Wrap text" },
+ { kind: "entry", label: "Align left", icon: ICON, isEnabled: true }
+ ];
+ host.show({ anchor, items, layout: "tiles", setElement: vi.fn(), onClose: vi.fn() });
+
+ const menu = document.querySelector<HTMLElement>(".tn-popup.tn-menu");
+ const rows = [ ...menu?.querySelectorAll(":scope > .tn-menu-scroll > li") ?? [] ].map((row) =>
+ (row.classList.contains("toolbar-group-menu-tiles")
+ ? [ ...row.querySelectorAll(".tn-menu-action") ].map((tile) => tile.textContent).join(", ")
+ : `# ${row.textContent}`));
+ expect(rows).toEqual([ "In line", "# Break text", "Align left, Align center", "# Wrap text", "Align left" ]);
+ });
+
describe("an entry with a submenu, in the tiles layout", () => {
afterEach(() => {
window.glob.device = "desktop";
diff --git a/apps/client/src/widgets/type_widgets/text/toolbar_group_menu.tsx b/apps/client/src/widgets/type_widgets/text/toolbar_group_menu.tsx
index 2a8182c843..b5206347b1 100644
--- a/apps/client/src/widgets/type_widgets/text/toolbar_group_menu.tsx
+++ b/apps/client/src/widgets/type_widgets/text/toolbar_group_menu.tsx
@@ -4,7 +4,7 @@ import type {
ToolbarGroupMenuEntry, ToolbarGroupMenuHost, ToolbarGroupMenuItem, ToolbarGroupMenuRequest
} from "@triliumnext/ckeditor5";
import clsx from "clsx";
-import { render } from "preact";
+import { Fragment, render } from "preact";
import { escapeHtml, isMobile, isNarrowLayout } from "../../../services/utils";
import {
@@ -122,37 +122,40 @@ function MenuRows({ items }: { items: ToolbarGroupMenuItem[] }) {
}
/**
- * The entries as tiles, a grid of them for each group between separators. An entry with a submenu
- * is a tile that opens it.
+ * The entries as tiles, a grid of them for each group between separators and headings, under its
+ * heading. An entry with a submenu is a tile that opens it.
*/
function MenuTileGroups({ items }: { items: ToolbarGroupMenuItem[] }) {
- const groups: ToolbarGroupMenuEntry[][] = [ [] ];
+ const groups: { heading?: string; entries: ToolbarGroupMenuEntry[] }[] = [ { entries: [] } ];
for (const item of items) {
if (item.kind === "entry") {
- groups[groups.length - 1].push(item);
+ groups[groups.length - 1].entries.push(item);
} else {
- groups.push([]);
+ groups.push({ heading: item.kind === "heading" ? item.label : undefined, entries: [] });
}
}
return (
<>
- {groups.map((group, index) => (
- <li key={index} className="tn-menu-actions tn-menu-actions-cards toolbar-group-menu-tiles" role="group">
- {group.map(({ label, icon, iconClass, isEnabled, isOn, run, children }, tileIndex) => (children
- ? (
- <FormDropdownSubmenu key={tileIndex} tile icon={iconClass} iconSvg={icon} title={label} disabled={!isEnabled}>
- <MenuRows items={children} />
- </FormDropdownSubmenu>
- )
- : (
- <MenuTile
- key={tileIndex} icon={iconClass} iconSvg={icon} title={escapeHtml(label)} tooltip={label}
- disabled={!isEnabled} checked={isOn} onSelect={() => run?.()}
- />
- )
- ))}
- </li>
+ {groups.filter(({ entries }) => entries.length).map(({ heading, entries }, index) => (
+ <Fragment key={index}>
+ {heading && <FormListHeader text={heading} />}
+ <li className="tn-menu-actions tn-menu-actions-cards toolbar-group-menu-tiles" role="group">
+ {entries.map(({ label, icon, iconClass, isEnabled, isOn, run, children }, tileIndex) => (children
+ ? (
+ <FormDropdownSubmenu key={tileIndex} tile icon={iconClass} iconSvg={icon} title={label} disabled={!isEnabled}>
+ <MenuRows items={children} />
+ </FormDropdownSubmenu>
+ )
+ : (
+ <MenuTile
+ key={tileIndex} icon={iconClass} iconSvg={icon} title={escapeHtml(label)} tooltip={label}
+ disabled={!isEnabled} checked={isOn} onSelect={() => run?.()}
+ />
+ )
+ ))}
+ </li>
+ </Fragment>
))}
</>
);
diff --git a/packages/ckeditor5/src/plugins/context_toolbar.spec.ts b/packages/ckeditor5/src/plugins/context_toolbar.spec.ts
index 1ffb8aa32c..5dc85af118 100644
--- a/packages/ckeditor5/src/plugins/context_toolbar.spec.ts
+++ b/packages/ckeditor5/src/plugins/context_toolbar.spec.ts
@@ -1,12 +1,13 @@
import {
_setModelData as setModelData,
- ButtonView, type ClassicEditor, DropdownView, Essentials, IconPreviousArrow, IconTable, Paragraph, Table, TableCaption, TableToolbar,
+ ButtonView, type ClassicEditor, DropdownView, Essentials, Image, ImageStyle, ImageToolbar, IconPreviousArrow, IconTable, Paragraph, Table, TableCaption, TableToolbar,
ToolbarSeparatorView, WidgetToolbarRepository
} from "ckeditor5";
import { describe, expect, it, vi } from "vitest";
import { createTestEditor } from "../../test/editor-kit.js";
import ContextToolbar from "./context_toolbar.js";
+import ImagePosition from "./image_position.js";
import ToolbarGroupMenu, { type ToolbarGroupMenuRequest } from "./toolbar_group_menu.js";
const TABLE = "<table><tableRow><tableCell><paragraph>a[]</paragraph></tableCell></tableRow></table><paragraph>b</paragraph>";
@@ -93,6 +94,27 @@ describe("ContextToolbar", () => {
expect(rows.flatMap((row) => (row.kind === "entry" ? [row.label] : []))).toContain("Insert column left");
});
+ it("keeps the layout a dropdown asks for itself", async () => {
+ const requests: ToolbarGroupMenuRequest[] = [];
+ const host = { show: vi.fn((request: ToolbarGroupMenuRequest) => requests.push(request)), hide: vi.fn(), destroy: vi.fn() };
+ const editor = await createTestEditor(
+ [Essentials, Paragraph, Image, ImageStyle, ImageToolbar, ImagePosition, ContextToolbar, ToolbarGroupMenu],
+ {
+ toolbar: ["contextToolbar"],
+ image: { toolbar: ["imagePosition"] },
+ toolbarGroupMenu: { host: () => host }
+ }
+ );
+ editor.ui.focusTracker.isFocused = true;
+ setModelData(editor.model, "[<imageBlock src=\"a.png\"></imageBlock>]<paragraph>b</paragraph>");
+ editor.ui.update();
+ getButton(editor).fire("execute");
+
+ const position = [...editor.plugins.get(ContextToolbar).toolbarView.items][2] as DropdownView;
+ position.buttonView.fire("open");
+ expect(requests.at(-1)?.layout).toBe("tiles");
+ });
+
it("leaves the balloons alone in an editor without its button", async () => {
const { editor } = await createEditor(["undo"]);
expect(editor.plugins.get(WidgetToolbarRepository).isEnabled).toBe(true);
diff --git a/packages/ckeditor5/src/plugins/context_toolbar.ts b/packages/ckeditor5/src/plugins/context_toolbar.ts
index e3f5c902e2..4722fcfe2d 100644
--- a/packages/ckeditor5/src/plugins/context_toolbar.ts
+++ b/packages/ckeditor5/src/plugins/context_toolbar.ts
@@ -5,7 +5,7 @@ import {
import type { Editor, ToolbarConfig, ToolbarConfigItem, ViewElement, ViewDocumentSelection } from "ckeditor5";
import admonitionIcon from "../icons/admonition.svg?raw";
-import { openListAsMenu } from "./toolbar_group_menu.js";
+import { isListMenu, openListAsMenu } from "./toolbar_group_menu.js";
/** The icons of the `contextToolbar` button, by the id a widget toolbar is registered under. */
const TOOLBAR_ICONS: Record<string, string> = {
@@ -100,7 +100,7 @@ export default class ContextToolbar extends Plugin {
this.toolbarView.items.addMany([this.backView, new ToolbarSeparatorView()]);
// Before `ToolbarGroupMenu`, which decides on a dropdown as it is added.
this.listenTo(this.toolbarView.items, "add", (_evt, item) => {
- if (item instanceof DropdownView) {
+ if (item instanceof DropdownView && !isListMenu(item)) {
openListAsMenu(item);
}
}, { priority: "highest" });
diff --git a/packages/ckeditor5/src/plugins/image_position.ts b/packages/ckeditor5/src/plugins/image_position.ts
index aa03e7ad4b..83d133f08d 100644
--- a/packages/ckeditor5/src/plugins/image_position.ts
+++ b/packages/ckeditor5/src/plugins/image_position.ts
@@ -6,12 +6,15 @@ import type {
Locale
} from "ckeditor5";
+import { openListAsMenu } from "./toolbar_group_menu.js";
+
/**
* Registers `imagePosition`, one dropdown for the styles of an image, in place of CKEditor's
* separate style buttons and their "Wrap text" and "Block align" dropdowns, whose rows read the
* same. The rows are grouped by how text runs around the image, as Word and Google Docs name it:
* in line with it, broken above and below it ("Break text"), or wrapped around it ("Wrap text").
- * The button shows the icon of the current style.
+ * The button shows the icon of the current style. As a menu of `ToolbarGroupMenu`, as on a phone,
+ * the rows are tiles under their headings.
*/
export default class ImagePosition extends Plugin {
@@ -76,6 +79,7 @@ export default class ImagePosition extends Plugin {
editor.execute("imageStyle", { value: styleName });
editor.editing.view.focus();
});
+ openListAsMenu(dropdown, { layout: "tiles" });
return dropdown;
}
}
diff --git a/packages/ckeditor5/src/plugins/toolbar_group_menu.ts b/packages/ckeditor5/src/plugins/toolbar_group_menu.ts
index 42b199618c..b4ef937fd6 100644
--- a/packages/ckeditor5/src/plugins/toolbar_group_menu.ts
+++ b/packages/ckeditor5/src/plugins/toolbar_group_menu.ts
@@ -99,6 +99,11 @@ export function openListAsMenu(dropdown: DropdownView, options: ListMenuOptions
listMenuDropdowns.set(dropdown, options);
}
+/** Whether `dropdown` was handed to {@link openListAsMenu}. */
+export function isListMenu(dropdown: DropdownView) {
+ return listMenuDropdowns.has(dropdown);
+}
+
/**
* Opens a toolbar group as a menu drawn by the host application (`toolbarGroupMenu.host`), with a
* row of icon and label per entry, and a submenu for an entry that carries a list of its own.