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
import {
ButtonView, IconPreviousArrow, IconText, Plugin, ToolbarSeparatorView, ToolbarView
} from "ckeditor5";
import type { Editor, ToolbarConfig } from "ckeditor5";
import FormatPainterUI from "./format_painter/format_painter_ui.js";
/**
* A second toolbar of text formatting, which the `textFormatting` button swaps in for the editor's
* own toolbar and the back button at its start swaps out again. The items come from the
* `textFormattingToolbar` configuration. The host application places {@link toolbarView} and
* shows it in place of the editor's toolbar while {@link isActive} is `true`.
*
* With items configured, the toolbar also follows the selection: it swaps in as text is selected,
* and out as the selection collapses, unless one of the buttons swapped it since.
*/
export default class TextFormattingToolbar extends Plugin {
/** Whether the toolbar is the one to show. */
declare isActive: boolean;
/** Whether a selection swapped the toolbar in, so a collapsed one swaps it out. */
private shownForSelection = false;
// Built before `afterInit()`, so `ToolbarGroupMenu` can watch it whichever plugin starts first.
readonly toolbarView: ToolbarView;
static get pluginName() {
return "TextFormattingToolbar" as const;
}
constructor(editor: Editor) {
super(editor);
this.set("isActive", false);
// Groups, as the editor's own toolbar does by default, which keeps the items on one line.
this.toolbarView = new ToolbarView(editor.locale, { shouldGroupWhenFull: true });
}
init() {
const editor = this.editor;
const t = editor.t;
editor.ui.componentFactory.add("textFormatting", (locale) => {
const button = new ButtonView(locale);
// The host marks a button that opens a row of its own (`ck-opens-row`).
button.set({ label: t("Text formatting"), icon: IconText, tooltip: true, class: "ck-opens-row" });
button.on("execute", () => this.setActive(true));
return button;
});
}
afterInit() {
const editor = this.editor;
const t = editor.t;
const back = new ButtonView(editor.locale);
back.set({ label: t("Back"), icon: IconPreviousArrow, tooltip: true });
back.on("execute", () => this.setActive(false));
// Grouping measures the rendered toolbar as items arrive.
this.toolbarView.render();
this.toolbarView.items.add(back);
const config = editor.config.get("textFormattingToolbar");
const items = Array.isArray(config) ? config : config?.items ?? [];
if (items.length) {
this.toolbarView.items.add(new ToolbarSeparatorView());
this.toolbarView.fillFromConfig(items, editor.ui.componentFactory);
this.followSelection();
}
editor.ui.addToolbar(this.toolbarView);
}
override destroy() {
super.destroy();
this.toolbarView.destroy();
}
/** The button that swaps the toolbars leaves the page with its toolbar, so the editor takes the focus. */
private setActive(isActive: boolean) {
this.isActive = isActive;
this.shownForSelection = false;
this.editor.editing.view.focus();
}
/**
* Swaps the toolbar as the selection turns from a caret into a range of text and back. A range
* that only grows or shrinks, as a selection handle is dragged, swaps nothing, and neither does
* a selected object, such as an image, which holds no text to format.
*/
private followSelection() {
const { model, plugins } = this.editor;
const selection = model.document.selection;
const holdsText = () => {
const selected = selection.getSelectedElement();
return !selection.isCollapsed && !(selected && model.schema.isObject(selected));
};
// An armed format painter keeps the toolbar, whose painter button applies or cancels it.
const painter = plugins.has(FormatPainterUI) ? plugins.get(FormatPainterUI) : undefined;
const swapOut = () => {
if (this.shownForSelection && !heldText && !painter?.isActive) {
this.isActive = false;
this.shownForSelection = false;
}
};
let heldText = holdsText();
this.listenTo(selection, "change:range", () => {
const isHoldingText = holdsText();
if (isHoldingText === heldText) {
return;
}
heldText = isHoldingText;
if (isHoldingText && !this.isActive) {
this.isActive = true;
this.shownForSelection = true;
} else {
swapOut();
}
});
if (painter) {
this.listenTo(painter, "change:isActive", swapOut);
}
}
}
declare module "ckeditor5" {
interface PluginsMap {
[TextFormattingToolbar.pluginName]: TextFormattingToolbar;
}
interface EditorConfig {
/** The items of the {@link TextFormattingToolbar}, after its back button. */
textFormattingToolbar?: ToolbarConfig;
}
}