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 { Autoformat, AutoLink, BlockQuote, BlockToolbar, Bold, CKFinderUploadAdapter, Clipboard, Code, CodeBlock, Enter, Font, FontBackgroundColor, FontColor, GeneralHtmlSupport, Heading, HeadingButtonsUI, HorizontalLine, Image, ImageCaption, ImageInline, ImageResize, ImageStyle, ImageToolbar, ImageUpload, Alignment, Indent, IndentBlock, Italic, Link, List, ListProperties, MentionEditing, PageBreak, Paragraph, ParagraphButtonUI, PasteFromOffice, PictureEditing, RemoveFormat, SelectAll, ShiftEnter, SpecialCharacters, SpecialCharactersEssentials, Strikethrough, Style, Subscript, Superscript, Table, TableCaption, TableCellProperties, TableColumnResize, TableProperties, TableSelection, TableToolbar, TextPartLanguage, TextTransformation, TodoList, Typing, Underline, Undo, Bookmark, EmojiPicker, FindAndReplaceEditing } from "ckeditor5";
// Nothing here comes from `ckeditor5-premium-features` any more: every premium plugin Trilium
// once loaded has an in-tree GPL replacement — `SlashCommand` -> `TriliumSlashCommands`,
// `FormatPainter` -> `TriliumFormatPainter`, `Template` -> `TriliumSnippets`. See each plugin's
// doc comment for the details.
import type { Plugin } from "ckeditor5";
import AdaptiveColors from "./plugins/adaptive_colors.js";
import ChildNotePlugin from "./plugins/child_note.js";
import CutToNotePlugin from "./plugins/cuttonote.js";
import UploadimagePlugin from "./plugins/uploadimage.js";
import ItalicAsEmPlugin from "./plugins/italic_as_em.js";
import StrikethroughAsDel from "./plugins/strikethrough_as_del.js";
import InternalLinkPlugin from "./plugins/internallink.js";
import InsertDateTimePlugin from "./plugins/insert_date_time.js";
import ReferenceLink from "./plugins/referencelink.js";
import NoPoweredByBadge from "./plugins/no_powered_by_badge.js";
import InlineFillerSpellcheck from "./plugins/inline_filler_spellcheck.js";
import RemoveFormatLinksPlugin from "./plugins/remove_format_links.js";
import IndentBlockShortcutPlugin from "./plugins/indent_block_shortcut.js";
import MarkdownImportPlugin from "./plugins/markdownimport.js";
import MentionCustomization from "./plugins/mention_customization.js";
import TriliumEmojiMention from "./plugins/mention/emoji_mention.js";
import TriliumMentionUI from "./plugins/mention/trilium_mention_ui.js";
import TriliumSlashCommands from "./plugins/mention/slash_commands.js";
import TriliumFormatPainter from "./plugins/format_painter/format_painter.js";
import ContentEmbed from "./plugins/content_embed/content_embed.js";
import BlockReference from "./plugins/block_reference/block_reference.js";
import InlineIcon from "./plugins/inline_icon/inline_icon.js";
import LinkEmbed from "./plugins/link_embed/link_embed.js";
import YouTubeVideoPlugin from "./plugins/youtube_video.js";
import Uploadfileplugin from "./plugins/file_upload/uploadfileplugin.js";
import FindInLinkWidgets from "./plugins/find_in_link_widgets.js";
import SyntaxHighlighting from "./plugins/syntax_highlighting/index.js";
import Kbd from "./plugins/keyboard_marker/keyboard_marker.js";
import Mermaid from "./plugins/mermaid/mermaid.js";
import Admonition from "./plugins/admonition/admonition.js";
import Collapsible from "./plugins/collapsible/collapsible.js";
import Tabs from "./plugins/tabs/tabs.js";
import Multicolumn from "./plugins/multicolumn/multicolumn.js";
import Footnotes from "./plugins/footnotes/footnotes.js";
import Math from "./plugins/math/math.js";
import AutoformatMath from "./plugins/math/autoformat_math.js";
import CopyAnchorLinkButton from "./plugins/copy_anchor_link.js";
import CopyLinkUrlButton from "./plugins/copy_link_url.js";
import ImageActions from "./plugins/image_actions.js";
import ImageToDrawing from "./plugins/image_to_drawing.js";
import ClipboardBareImage from "./plugins/clipboard_bare_image.js";
import ClipboardImageEmbed from "./plugins/clipboard_image_embed.js";
import ImageEditingSource from "./plugins/image_editing_source.js";
import ClipboardPageStyles from "./plugins/clipboard_page_styles.js";
import ClipboardPlainTextIndent from "./plugins/clipboard_plain_text_indent.js";
import PasteFromVsCode from "./plugins/paste_from_vscode.js";
import TriliumSnippets from "./plugins/snippets/snippets.js";
import TriliumAiAssistant from "./plugins/ai_assistant/ai_assistant.js";
import CodeBlockToolbar from "./plugins/code_block_toolbar.js";
import CodeBlockLanguageDropdown from "./plugins/code_block_language_dropdown.js";
import CodeBlockInsertParagraph from "./plugins/code_block_insert_paragraph.js";
import CodeBlockHljsClass from "./plugins/code_block_hljs_class.js";
import MoveBlockUpDownPlugin from "./plugins/move_block_updown.js";
import DeleteBlocks from "./plugins/delete_blocks.js";
import ScrollOnUndoRedoPlugin from "./plugins/scroll_on_undo_redo.js"
import InlineCodeNoSpellcheck from "./plugins/inline_code_no_spellcheck.js";
import InlineCodeToolbar from "./plugins/inline_code_toolbar.js";
import AdmonitionTypeDropdown from "./plugins/admonition/admonition_type_dropdown.js";
import AdmonitionToolbar from "./plugins/admonition/admonition_toolbar.js";
import ContentEmbedBoxSizeDropdown
from "./plugins/content_embed/content_embed_box_size_dropdown.js";
import ContentEmbedPositionDropdown
from "./plugins/content_embed/content_embed_position_dropdown.js";
import ContentEmbedToolbar from "./plugins/content_embed/content_embed_toolbar.js";
import ContentEmbedCaret from "./plugins/content_embed/content_embed_caret.js";
import ExtendedCodeBlock from "./plugins/content_embed/extended_code_block.js";
import LinkEmbedToolbar from "./plugins/link_embed/link_embed_toolbar.js";
import NoteLinkToolbar from "./plugins/note_link_toolbar.js";
import TodoListMultistate from "./plugins/todo_list_multistate/todo_list_multistate.js";
import TodoListUncheckOnEnter from "./plugins/todo_list_uncheck_on_enter.js";
import CollapsibleListItems from "./plugins/collapsible_list_items.js";
import ListItemAlignment from "./plugins/list_item_alignment.js";
import TableIndent from "./plugins/table_indent.js";
import TableContextMenu from "./plugins/table_context_menu.js";
import TableMove from "./plugins/table_move/table_move.js";
import TablePasteRows from "./plugins/table_paste_rows.js";
import TableSort from "./plugins/table_sort.js";
import SortSelection from "./plugins/sort_selection/sort_selection.js";
import TableInsertUI from "./plugins/table_insert/table_insert_ui.js";
import TableToolbarDropdowns from "./plugins/table_toolbar_dropdowns.js";
import TriliumTableScroll from "./plugins/table_scroll.js";
import TableStickyHeader from "./plugins/table_sticky_header.js";
import TableColumnBar from "./plugins/table_column_bar/table_column_bar.js";
import TableTouchSelection from "./plugins/table_touch_selection/table_touch_selection.js";
import ToolbarGroupMenu from "./plugins/toolbar_group_menu.js";
import MobileToolbarItems from "./plugins/mobile_toolbar_items.js";
import TextFormattingToolbar from "./plugins/text_formatting_toolbar.js";
import ContextToolbar from "./plugins/context_toolbar.js";
import ImagePosition from "./plugins/image_position.js";
import ColorMenu from "./plugins/color_menu.js";
import BlockDragHandle from "./plugins/block_drag_handle.js";
import SkipUnchangedAttributes from "./plugins/skip_unchanged_attributes.js";
/**
* Plugins that are specific to Trilium and not part of the CKEditor 5 core, included in both text editors but not in the attribute editor.
*/
const TRILIUM_PLUGINS: typeof Plugin[] = [
UploadimagePlugin,
CutToNotePlugin,
ItalicAsEmPlugin,
StrikethroughAsDel,
InternalLinkPlugin,
ChildNotePlugin,
InsertDateTimePlugin,
RemoveFormatLinksPlugin,
IndentBlockShortcutPlugin,
MarkdownImportPlugin,
ContentEmbed,
BlockReference,
InlineIcon,
LinkEmbed,
YouTubeVideoPlugin,
Uploadfileplugin,
SyntaxHighlighting,
CodeBlockLanguageDropdown,
CodeBlockToolbar,
CodeBlockInsertParagraph,
CodeBlockHljsClass,
MoveBlockUpDownPlugin,
DeleteBlocks,
ScrollOnUndoRedoPlugin,
InlineCodeNoSpellcheck,
InlineCodeToolbar,
AdmonitionTypeDropdown,
AdmonitionToolbar,
ContentEmbedBoxSizeDropdown,
ContentEmbedPositionDropdown,
ContentEmbedToolbar,
ContentEmbedCaret,
ExtendedCodeBlock,
LinkEmbedToolbar,
NoteLinkToolbar,
TodoListMultistate,
CollapsibleListItems,
ListItemAlignment,
TableIndent,
TableContextMenu,
TableMove,
TablePasteRows,
TableSort,
SortSelection,
TableInsertUI,
TableToolbarDropdowns,
TriliumTableScroll,
TableStickyHeader,
TableColumnBar,
TableTouchSelection,
ToolbarGroupMenu,
MobileToolbarItems,
TextFormattingToolbar,
ContextToolbar,
ImagePosition,
ColorMenu,
CopyAnchorLinkButton,
CopyLinkUrlButton,
ImageActions,
ImageToDrawing,
ClipboardImageEmbed,
ImageEditingSource,
ClipboardBareImage,
ClipboardPageStyles,
ClipboardPlainTextIndent,
PasteFromVsCode,
AdaptiveColors,
TriliumSnippets,
TriliumAiAssistant,
FindInLinkWidgets,
SkipUnchangedAttributes,
];
/**
* External plugins that are not part of the CKEditor 5 core and not part of Trilium, included in both text editors but not in the attribute editor.
*/
const EXTERNAL_PLUGINS: typeof Plugin[] = [
Kbd,
Mermaid,
Admonition,
Collapsible,
Tabs,
Multicolumn,
Footnotes,
Math,
AutoformatMath
];
/**
* The minimal set of plugins required for the editor to work. This is used both in normal text editors (floating or fixed toolbar) and in the attribute editor.
*/
export const CORE_PLUGINS: typeof Plugin[] = [
Clipboard, Enter, SelectAll,
ShiftEnter, Typing, Undo,
Paragraph,
// `MentionEditing` + `TriliumMentionUI` rather than the `Mention` façade: the façade also pulls
// in upstream's `MentionUI`, which `TriliumMentionUI` replaces. See its doc comment for why.
MentionEditing,
// Trilium plugins
TriliumMentionUI,
MentionCustomization,
ReferenceLink,
NoPoweredByBadge,
InlineFillerSpellcheck
];
/**
* Lightweight formatting plugins for a minimal reply input (e.g. the AI chat) — added on top of an
* {@link AttributeEditor} instance via `extraPlugins` to enable markdown **autoformatting** for block
* quotes, fenced code blocks, lists and links, without a toolbar. Kept out of {@link CORE_PLUGINS} so
* the plain attribute/relation editor stays plain.
*/
export const CHAT_INPUT_PLUGINS: typeof Plugin[] = [
Autoformat,
BlockQuote,
CodeBlock,
List,
Link,
AutoLink
];
/**
* {@link CHAT_INPUT_PLUGINS} and the marks a sentence is written with, for an input whose text is
* kept rather than sent on — the memo of a mind map node. Added to an {@link AttributeEditor} the
* same way, and worth a toolbar there: a {@link BalloonEditor} raises one over the selection out of
* whatever `toolbar` it is configured with.
*
* Kept apart from {@link CHAT_INPUT_PLUGINS} rather than added to it, though the chat box would
* take these as readily: what is typed there is turned into markdown before it is sent, and that
* pass keeps the text of an inline wrapper and drops the wrapper. Bold offered there would be bold
* lost on its way to the model.
*
* `Autoformat` is what carries most of this: it registers `**bold**`, `_italic_`, `` `code` `` and
* `~~struck~~` only where the matching command exists, so the marks below are what make those
* spellings work at all — and the plainer way in, for anyone who would rather type than reach.
*
* The two Trilium converters ride along with them: they are what write italics as `<em>` and a
* strikethrough as `<del>`, which is how the rest of Trilium stores both.
*/
export const MEMO_PLUGINS: typeof Plugin[] = [
...CHAT_INPUT_PLUGINS,
Bold,
Italic,
ItalicAsEmPlugin,
Strikethrough,
StrikethroughAsDel,
Code
];
/**
* The set of plugins that are required for the editor to work. This is used in normal text editors (floating or fixed toolbar) but not in the attribute editor.
*/
export const COMMON_PLUGINS: typeof Plugin[] = [
...CORE_PLUGINS,
CKFinderUploadAdapter,
Autoformat,
Bold,
Italic,
Underline,
Strikethrough,
FindAndReplaceEditing,
Code,
Superscript,
Subscript,
BlockQuote,
Heading,
Image,
ImageCaption,
ImageStyle,
ImageToolbar,
ImageUpload,
ImageResize,
ImageInline,
Link,
AutoLink,
List,
ListProperties,
TodoList,
TodoListUncheckOnEnter,
PasteFromOffice,
PictureEditing,
Table,
TableToolbar,
TableProperties,
TableCellProperties,
TableSelection,
TableCaption,
TableColumnResize,
Alignment,
Indent,
IndentBlock,
ParagraphButtonUI,
HeadingButtonsUI,
TextTransformation,
Font,
FontColor,
FontBackgroundColor,
CodeBlock,
SelectAll,
HorizontalLine,
RemoveFormat,
SpecialCharacters,
SpecialCharactersEssentials,
PageBreak,
GeneralHtmlSupport,
TextPartLanguage,
Style,
Bookmark,
// Upstream's `EmojiMention` is replaced by `TriliumEmojiMention` for the same reason as
// `SlashCommand` — it `requires` the `Mention` façade. `EmojiPicker` and `EmojiRepository` do
// not, so the picker and the emoji data stay upstream's.
EmojiPicker,
TriliumEmojiMention,
TriliumSlashCommands,
// GPL reimplementation of premium `FormatPainter` (the `formatPainter` toolbar button), built on
// the public `isFormatting` schema flag, so the commercial plugin can be dropped.
TriliumFormatPainter,
...TRILIUM_PLUGINS,
...EXTERNAL_PLUGINS
];
/**
* The set of plugins specific to the fixed toolbar mode. `BlockDragHandle` gives it the block drag
* handle that the popup editor gets from `BlockToolbar`.
*/
export const CLASSIC_EDITOR_PLUGINS: typeof Plugin[] = [
...COMMON_PLUGINS,
BlockDragHandle,
];
/**
* The set of plugins specific to the popup editor (floating toolbar mode), and not the fixed toolbar mode.
*/
export const POPUP_EDITOR_PLUGINS: typeof Plugin[] = [
...COMMON_PLUGINS,
BlockToolbar,
];