Skip to content

domternal/domternal

Repository files navigation

Domternal

Domternal Editor

A lightweight, extensible rich text editor toolkit built on ProseMirror. Framework-agnostic headless core with first-class Angular, React, and Vue support. Use it headless with vanilla JS/TS, add the built-in toolbar and theme, or drop in ready-made framework components. Fully tree-shakeable, import only what you use, unused extensions are stripped from your bundle.

License: MIT CI npm

Website · Getting Started · Packages & Bundle Size

StackBlitz (Angular) · StackBlitz (React) · StackBlitz (Vue) · StackBlitz (Vanilla TS)

Features

  • Headless core - use with any framework or vanilla JS/TS
  • Angular components - editor, toolbar, bubble menu, floating menu, emoji picker (signals, OnPush, zoneless-ready)
  • React components - composable Domternal component, toolbar, bubble menu, floating menu, emoji picker, custom node views (React 18+)
  • Vue components - composable Domternal component, useEditor/useEditorState composables, toolbar, bubble menu, floating menu, emoji picker, custom node views (Vue 3.3+)
  • 57 extensions across 12 packages - 23 nodes, 9 marks, and 25 behavior extensions
  • 140+ chainable commands - editor.chain().focus().toggleBold().run()
  • Full table support - cell merging, column resize, row/column controls, cell toolbar, all free and MIT licensed
  • Tree-shakeable - import only what you use, your bundler strips the rest
  • ~38 KB gzipped (own code), ~108 KB total with ProseMirror
  • TypeScript first - 100% typed, zero any
  • 8,500+ tests - 2,677 unit tests and 5,800+ E2E tests across 120+ Playwright specs
  • Light and dark theme - 70+ CSS custom properties for full visual control
  • Inline styles export - getHTML({ styled: true }) produces inline CSS ready for email clients, CMS, and Google Docs
  • SSR helpers - generateHTML, generateJSON, generateText for server-side rendering

Quick Start

Headless (Vanilla JS/TS)

pnpm add @domternal/core
import { Editor, Document, Text, Paragraph, Bold, Italic, Underline } from '@domternal/core';

const editor = new Editor({
  element: document.getElementById('editor')!,
  extensions: [Document, Text, Paragraph, Bold, Italic, Underline],
  content: '<p>Hello <strong>World</strong>!</p>',
});

Import only what you need for full control and zero bloat. Use StarterKit for a batteries-included setup with headings, lists, code blocks, history, and more.

Getting Started Guide - headless core, themed UI with toolbar, and Angular/React/Vue component setup

StackBlitz (Angular) - full Angular example with all extensions, toolbar, and bubble menu

StackBlitz (React) - full React example with composable components, toolbar, and bubble menu

StackBlitz (Vue) - full Vue example with composable components, toolbar, and bubble menu

StackBlitz (Vanilla TS) - full vanilla example with toolbar, bubble menu, and all extensions

Packages

Package Description
@domternal/core Editor engine with 13 nodes, 9 marks, 25 extensions, toolbar controller, and 45 built-in icons
@domternal/theme Light and dark themes with 70+ CSS custom properties
@domternal/angular 5 Angular components: editor, toolbar, bubble menu, floating menu, emoji picker
@domternal/react React 18+ wrapper: composable component, toolbar, bubble menu, floating menu, emoji picker, node views
@domternal/vue Vue 3.3+ wrapper: composable component, composables, toolbar, bubble menu, floating menu, emoji picker, node views
@domternal/pm ProseMirror re-exports (state, view, model, transform, commands, keymap, history, tables, and more)
@domternal/extension-table Tables with 18 commands: merge, split, resize, cell styling, row/column controls
@domternal/extension-image Image with paste/drop upload, URL input, XSS protection, bubble menu
@domternal/extension-emoji Emoji picker panel and :shortcode: autocomplete
@domternal/extension-mention @mention autocomplete with multi-trigger and async support
@domternal/extension-details Collapsible details/accordion blocks
@domternal/extension-code-block-lowlight Syntax-highlighted code blocks powered by lowlight

See Packages & Bundle Size for a full breakdown of what each package includes and how tree-shaking works.

Documentation

Full documentation, live playgrounds, and API reference at domternal.dev.

Contributing

See CONTRIBUTING.md for commit conventions, PR guidelines, and development setup.

pnpm install    # Install dependencies
pnpm build      # Build all packages
pnpm test       # Run tests
pnpm lint       # Run linter
pnpm typecheck  # Type check

Requires Node.js >= 20 and pnpm >= 10.

License

MIT

About

Lightweight, extensible rich text editor toolkit built on ProseMirror. Headless core for any framework or native Angular/React/Vue components. Built-in toolbar and theme, full table support, 57 extensions. MIT licensed.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors

Languages