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 {
Plugin,
WidgetToolbarRepository,
isWidget,
type ViewElement,
Collection,
ViewModel,
createDropdown,
addListToDropdown,
ButtonView,
DropdownButtonView,
IconPencil,
IconUnlink,
type ListDropdownButtonDefinition,
type Locale,
type Command
} from "ckeditor5";
import { COMMAND_NAME as LINK_DIALOG_COMMAND } from "../internallink.js";
import LinkEmbed, {
CHANGE_LINK_DISPLAY_COMMAND,
getLinkDisplayModeLabel,
LINK_DISPLAY_MODES,
REMOVE_LINK_EMBED_COMMAND,
type LinkDisplayMode
} from "./link_embed.js";
import { createCopyUrlButton } from "../copy_link_url.js";
export default class LinkEmbedToolbar extends Plugin {
static get requires() {
return [
WidgetToolbarRepository, LinkEmbed, LinkEmbedLinkButton, LinkEmbedCopyUrlButton,
LinkEmbedEditLinkButton, LinkEmbedUnlinkButton, LinkEmbedDisplayDropdown
] as const;
}
afterInit() {
const widgetToolbarRepository = this.editor.plugins.get(WidgetToolbarRepository);
widgetToolbarRepository.register("linkEmbed", {
items: [
"linkEmbedLink", "linkEmbedCopyUrl", "linkEmbedEditLink", "linkEmbedUnlink", "|",
"linkEmbedDisplayDropdown"
],
balloonClassName: "ck-toolbar-container link-embed-toolbar",
getRelatedElement(selection) {
const selectedElement = selection.getSelectedElement();
if (selectedElement && isLinkEmbedWidget(selectedElement)) {
return selectedElement;
}
return null;
}
});
}
}
function isLinkEmbedWidget(element: ViewElement): boolean {
if (!isWidget(element)) {
return false;
}
// Match both linkEmbed (<section.link-embed>) and linkMention (<span.link-mention>)
if (element.is("element", "section")) {
const classes = element.getAttribute("class") || "";
return typeof classes === "string" && classes.includes("link-embed");
}
if (element.is("element", "span")) {
const classes = element.getAttribute("class") || "";
return typeof classes === "string" && classes.includes("link-mention");
}
return false;
}
export class LinkEmbedDisplayDropdown extends Plugin {
static get requires() {
return [LinkEmbed] as const;
}
public init() {
const editor = this.editor;
const componentFactory = editor.ui.componentFactory;
const command = editor.commands.get(CHANGE_LINK_DISPLAY_COMMAND) as Command & { value: LinkDisplayMode | null; embedAvailable: boolean };
componentFactory.add("linkEmbedDisplayDropdown", _locale => {
const dropdownView = createDropdown(editor.locale, DropdownButtonView);
const displayLabel = editor.t("Display");
dropdownView.buttonView.set({
withText: true,
tooltip: true,
label: displayLabel
});
dropdownView.bind("isEnabled").to(command, "isEnabled");
// The dropdown also sits in the native link balloon (see `link.toolbar` in the client
// config), which opens for links that cannot be previewed at all — an internal note
// link, say. There it hides rather than showing permanently disabled.
dropdownView.bind("class").to(command, "isEnabled", (isEnabled) => (isEnabled ? "" : "ck-hidden"));
dropdownView.buttonView.bind("label").to(command, "value", (value) => {
if (!value) return displayLabel;
return getLinkDisplayModeLabel(editor.t, value);
});
dropdownView.on("execute", evt => {
const source = evt.source as any;
editor.execute(CHANGE_LINK_DISPLAY_COMMAND, {
value: source._displayMode
});
editor.editing.view.focus();
});
addListToDropdown(dropdownView, this._getItemDefinitions(command));
return dropdownView;
});
}
private _getItemDefinitions(command: Command & { value: LinkDisplayMode | null; embedAvailable: boolean }): Collection<ListDropdownButtonDefinition> {
const items = new Collection<ListDropdownButtonDefinition>();
for (const mode of LINK_DISPLAY_MODES) {
const definition: ListDropdownButtonDefinition = {
type: "button",
model: new ViewModel({
_displayMode: mode,
label: getLinkDisplayModeLabel(this.editor.t, mode),
role: "menuitemradio",
withText: true
})
};
definition.model.bind("isOn").to(command, "value", value => {
return value === mode;
});
// Hide "Embed" when the URL doesn't support it.
if (mode === "embed") {
definition.model.bind("isVisible").to(command, "embedAvailable");
}
items.add(definition);
}
return items;
}
}
/**
* Registers the `linkEmbedLink` toolbar item: the leading segment of the link
* embed balloon that shows the widget's URL and opens it in a new tab when
* clicked — mirroring CKEditor's own link toolbar preview button.
*/
class LinkEmbedLinkButton extends Plugin {
static get requires() {
return [LinkEmbed] as const;
}
public init() {
const editor = this.editor;
const command = editor.commands.get(CHANGE_LINK_DISPLAY_COMMAND) as (Command & { url: string | null }) | undefined;
editor.ui.componentFactory.add("linkEmbedLink", locale => {
const button = new LinkEmbedPreviewButtonView(locale);
button.set("tooltip", locale.t("Open link in new tab"));
/* v8 ignore next -- LinkEmbedEditing always registers CHANGE_LINK_DISPLAY_COMMAND (this plugin requires LinkEmbed), so the no-command branch is unreachable */
if (command) {
button.bind("isEnabled").to(command, "url", url => !!url);
button.bind("label").to(command, "url", url => url ?? undefined);
button.bind("href").to(command, "url", url => url ?? undefined);
}
return button;
});
}
}
/**
* Registers the `linkEmbedCopyUrl` toolbar item: copies the selected widget's URL
* to the clipboard, mirroring the default link toolbar's copy-URL button.
*/
export class LinkEmbedCopyUrlButton extends Plugin {
static get requires() {
return [LinkEmbed] as const;
}
public init() {
const editor = this.editor;
const command = editor.commands.get(CHANGE_LINK_DISPLAY_COMMAND) as (Command & { url: string | null }) | undefined;
editor.ui.componentFactory.add("linkEmbedCopyUrl", locale =>
createCopyUrlButton(editor, locale, () => command?.url)
);
}
}
/**
* Registers the `linkEmbedUnlink` toolbar item: removes the link preview, leaving
* the bare URL as plain text — mirroring the default link toolbar's unlink button
* (same icon, same "remove the link" semantics).
*/
class LinkEmbedUnlinkButton extends Plugin {
static get requires() {
return [LinkEmbed] as const;
}
public init() {
const editor = this.editor;
const command = editor.commands.get(REMOVE_LINK_EMBED_COMMAND);
editor.ui.componentFactory.add("linkEmbedUnlink", locale => {
const button = new ButtonView(locale);
button.set({
label: locale.t("Unlink"),
icon: IconUnlink,
tooltip: true
});
/* v8 ignore next -- LinkEmbedEditing always registers REMOVE_LINK_EMBED_COMMAND (this plugin requires LinkEmbed), so the no-command branch is unreachable */
if (command) {
button.bind("isEnabled").to(command, "isEnabled");
}
button.on("execute", () => {
editor.execute(REMOVE_LINK_EMBED_COMMAND);
editor.editing.view.focus();
});
return button;
});
}
}
/**
* Registers the `linkEmbedEditLink` toolbar item: opens the host's link dialog on the selected
* preview, as the `editLink` button of the link toolbar does on a native link. The dialog edits its
* address, title and display.
*/
class LinkEmbedEditLinkButton extends Plugin {
static get requires() {
return [LinkEmbed] as const;
}
public init() {
const editor = this.editor;
editor.ui.componentFactory.add("linkEmbedEditLink", (locale) => {
const command = editor.commands.get(LINK_DIALOG_COMMAND);
const button = new ButtonView(locale);
button.set({
label: editor.t("Edit link"),
icon: IconPencil,
tooltip: true,
isEnabled: false
});
if (command) {
button.bind("isEnabled").to(command, "isEnabled");
}
button.on("execute", () => editor.execute(LINK_DIALOG_COMMAND));
return button;
});
}
}
/**
* A {@link ButtonView} rendered as an `<a target="_blank">` so a click opens the
* URL in a new tab. Reuses CKEditor's `ck-link-toolbar__preview` styling for
* visual parity with the built-in link toolbar. Like CKEditor's preview button, it fires
* `navigate` on a click, whose listener can cancel opening the URL.
*/
export class LinkEmbedPreviewButtonView extends ButtonView {
declare href: string | undefined;
constructor(locale: Locale) {
super(locale);
const bind = this.bindTemplate;
this.set("href", undefined);
this.set("withText", true);
this.extendTemplate({
attributes: {
class: ["ck-link-toolbar__preview"],
href: bind.to("href"),
target: "_blank",
rel: "noopener noreferrer"
},
on: {
click: bind.to((event) => {
if (this.href) {
this.fire<LinkEmbedPreviewNavigateEvent>("navigate", this.href,
() => event.preventDefault());
}
})
}
});
/* v8 ignore next -- ButtonView always builds a template, and extendTemplate() above would have thrown otherwise, so the no-template branch is unreachable */
if (this.template) {
this.template.tag = "a";
}
}
}
/**
* Fired by a click on a `LinkEmbedPreviewButtonView`, with its `href` and a function that cancels
* opening it.
*/
export type LinkEmbedPreviewNavigateEvent = {
name: "navigate";
args: [ href: string, cancel: () => void ];
};