@thescaffold/editor-addons

Built-in addons for X Editor. Provides 80+ addons covering schema, marks, blocks, lists, tables, media, inline elements, UI shell, document structure, export, tools, collaboration, code mode, and utility features.

Installation

npm install @thescaffold/editor-addons @thescaffold/editor-core

Usage

import "@thescaffold/editor-core/define";
import {
  SchemaAddon,
  CommandsAddon,
  KeymapAddon,
  HistoryAddon,
  BoldAddon,
  ItalicAddon,
  HeadingsAddon,
  ToolbarAddon,
  StatusBarAddon,
  PlaceholderAddon,
  CountAddon,
} from "@thescaffold/editor-addons";

const el = document.querySelector("x-editor");
el.config = {
  mode: "doc",
  addons: [
    SchemaAddon(),
    CommandsAddon(),
    KeymapAddon(),
    HistoryAddon(),
    BoldAddon(),
    ItalicAddon(),
    HeadingsAddon(),
    ToolbarAddon({ position: "top" }),
    StatusBarAddon({ slots: ["wordCount", "charCount"] }),
    PlaceholderAddon({ text: "Start writing…" }),
    CountAddon(),
  ],
};

Addon Categories

| Category | Addons | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Base | SchemaAddon, CommandsAddon, KeymapAddon, InputRulesAddon, HistoryAddon | | Marks | BoldAddon, ItalicAddon, UnderlineAddon, StrikethroughAddon, InlineCodeAddon, SubscriptAddon, SuperscriptAddon, HighlightAddon, TextColorAddon, FontFamilyAddon, FontSizeAddon, ClearFormattingAddon | | Formatting | AlignmentAddon, LineHeightAddon, ParagraphSpacingAddon, IndentAddon | | Blocks | HeadingsAddon, BlockquoteAddon, DividerAddon, PageBreakAddon, CalloutAddon, DetailsAddon, ColumnsAddon, CodeBlockAddon | | Lists | BulletListAddon, OrderedListAddon, TaskListAddon, ToggleListAddon, ListsAddon | | Tables | TableAddon | | Media | ImageAddon, VideoAddon, AudioAddon, FileAddon, EmbedAddon, BookmarkAddon | | Inline | LinkAddon, MentionAddon, EmojiAddon, EquationAddon, FootnoteAddon, SmartChipAddon | | UI Shell | ToolbarAddon, BubbleMenuAddon, SlashMenuAddon, CommandPaletteAddon, BlockHandlesAddon, ContextMenuAddon, StatusBarAddon | | Structure | TableOfContentsAddon, OutlineAddon, CoverAddon, BreadcrumbAddon, TemplatesAddon, PageSetupAddon | | Export | ContentAddon, DocxAddon, PdfAddon, PrintAddon | | Tools | SearchAddon, SpellCheckAddon, GrammarAddon, AutoSaveAddon, ReadOnlyAddon | | Collab | CollabAddon, AwarenessAddon, PresenceAddon, CommentsAddon, SuggestionsAddon, VersionAddon | | Code | CodeAddon, LineNumbersAddon, CodeFoldingAddon, BracketMatchingAddon, CodeAutoCompleteAddon, CodeLintAddon, DiffAddon, MiniMapAddon | | Utility | PlaceholderAddon, CountAddon, ReadingTimeAddon, FocusModeAddon, FullScreenAddon, AccessibilityAddon, MarkdownAddon |

License

MIT