Skip to content

Build your personal knowledge base with Trilium Notes

2.0 KB
Raw Blame
import { Command, MentionEditing, Plugin, ModelRange, type ModelSelectable } from "ckeditor5";

import TriliumMentionUI from "./mention/trilium_mention_ui.js";

/**
 * Overrides the actions taken by the Mentions plugin (triggered by `@` in the text editor, or `~` & `#` in the attribute editor):
 *
 * - Auto-completes attributes and relations in the attribute editor.
 * - Inserts a reference link when a note is mentioned.
 */
export default class MentionCustomization extends Plugin {

    static get requires() {
		return [ MentionEditing, TriliumMentionUI ];
	}

    public static get pluginName() {
		return "MentionCustomization" as const;
	}

	afterInit() {
		const editor = this.editor;
		// override standard mention command (see https://github.com/ckeditor/ckeditor5/issues/6470)
		editor.commands.add('mention', new CustomMentionCommand(editor));
	}
}

interface MentionOpts {
    mention: string | {
        id: string;
        [key: string]: unknown;
    };
    marker: string;
    text?: string;
    range?: ModelRange;
}

interface MentionAttribute {
    id: string;
    notePath: string;
}

class CustomMentionCommand extends Command {

	override execute(options: MentionOpts) {
		const {model} = this.editor;
		const {document} = model;
		const {selection} = document;
		const mention = options.mention as unknown as MentionAttribute;
		const range = (options.range || selection.getFirstRange()) as ModelSelectable;

		if (mention.id.startsWith('#') || mention.id.startsWith('~')) {
			model.change(writer => {
				// Replace a range with the text with a mention.
				model.insertContent( writer.createText( mention.id, {} ), range );
			});
		}
		else {
			this.insertReference(range, mention.notePath);
		}
	}

	insertReference(range: ModelSelectable, notePath: string) {
		const {model} = this.editor;

		model.change(writer => {
			// override the selection or at least the beginning @ character
			model.insertContent(writer.createText('', {}), range);

			this.editor.execute('referenceLink', {href: '#' + notePath});
		});
	}
}