Yoopta-Editor v6

Motivation. Why Yoopta?

Yoopta is fully open source and built with all my heart and love. It was born from real pain

I've integrated rich-text editors into products more times than I'd like to admit. Every time it was the same story: wrestling with complex APIs, fighting against opinionated UI that doesn't fit your product, hacking around limitations, and writing glue code that makes you mass text your wife and check hair transplant prices (I'm currently accepting donations for the procedure — every star on GitHub brings me one follicle closer).

Yoopta was built to end that cycle. The idea is simple: give developers a headless core when they need full control, but also ship 20+ ready-made plugins, pre-built UI components (toolbars, slash menus, block actions), and theme presets (shadcn, Material) — so you can launch a polished editing experience without thinking about implementing a rich-text editor in your project and engage in other business tasks

Whether you're building a simple blog editor, a Notion-like workspace, a CMS for landing pages, or even a full website builder — Yoopta gives you the primitives to get there

If Yoopta saves you time, consider starring the repo or sponsoring the project. It keeps the project alive

Introduction

Yoopta-Editor is a free, open-source rich-text editor built for React apps. It's packed with features that let you build an editor as powerful and user-friendly as Notion, Craft, Coda, Medium etc. — or go further and build a CMS, landing page builder, or website builder on top of it.

Built on top of Slate.js with a powerful plugin architecture, Yoopta-Editor gives you the flexibility to customize everything—tweak the look, add features, or craft a completely custom user interface. The core is headless by default; Yoopta also provides pre-built theme presets so you can get a full editing experience and start quickly (shadcn theme @yoopta/themes-shadcn is available now; Material theme is in progress). Pre-built UI components via @yoopta/ui (toolbars, menus, block actions) let you improve the editing experience without building everything from scratch.

Examples & Demos

See what you can build with Yoopta:

Features

• Easy setup — Sensible defaults; plugins and marks passed to createYooptaEditor, then render <YooptaEditor />
• 20+ plugins — Paragraph, headings, lists, code, image, video, table, callout, accordion, tabs, steps, divider, embed, file, link, mention, carousel, table-of-contents, and more
• Headless core — Full control over UI; optional pre-built theme presets (@yoopta/themes-shadcn available, @yoopta/themes-material in progress) for styled block UI
• Pre-built UI components (@yoopta/ui) — FloatingToolbar, SlashCommandMenu, ActionMenuList, BlockOptions, ElementOptions, FloatingBlockActions, SelectionBox, BlockDndContext so you don't have to build everything from scratch
• Blocks, Elements, Marks APIs — Programmatic control: insert/update/delete blocks and elements, apply text formatting (Bold, Italic, Highlight, etc.), custom marks supported
• Undo/redo — Built-in history with editor.undo() / editor.redo(); batch operations for single undo step
• Drag and drop — Reorder blocks with nested depth support; optional SortableBlock for custom DnD
• Selection box — Multi-block selection for copy, delete, or bulk operations
• Slash command & action menu — Type / for block insertion; floating block actions (+, drag handle, block options)
• Inline elements — Links, @mentions, and custom inline nodes within text
• Export — HTML, Markdown, plain text, email template; get/set content as Yoopta JSON
• Real-time collaboration (@yoopta/collaboration) — Multi-user editing with Yjs CRDT, presence (awareness), remote cursors, and WebSocket provider; optional package for collaborative documents
• Events — editor.on('change' | 'focus' | 'blur' | 'path-change' | 'block:copy') for sync, analytics, or custom logic
• Keyboard shortcuts — Customizable hotkeys; Tab/Shift+Tab for indent/outdent; shortcuts per plugin and mark
• Read-only mode — Use the same editor instance for viewing or editing
• TypeScript — Full type definitions for editor, blocks, elements, and plugins
• Mobile friendly — Touch support; works in responsive layouts
• Custom plugins & marks — Define new block types or text formats and plug them in
• Media & large docs — Image/video optimization, lazy loading; performant with many blocks
• Theming — CSS variables (light/dark); theme packages for plugin element styling

Installation

# Install peer dependencies and core packages
yarn add slate slate-react slate-dom @yoopta/editor

# Add plugins you need
yarn add @yoopta/paragraph @yoopta/headings @yoopta/lists @yoopta/blockquote @yoopta/code @yoopta/image @yoopta/video @yoopta/embed @yoopta/file @yoopta/callout @yoopta/divider @yoopta/accordion @yoopta/table @yoopta/tabs @yoopta/steps @yoopta/mention @yoopta/links

# Add marks for text formatting
yarn add @yoopta/marks

# Add UI components
yarn add @yoopta/ui

# Optional: theme for styled block UI (Shadcn or Material)
yarn add @yoopta/themes-shadcn

# Optional: real-time collaboration (Yjs, awareness, remote cursors)
yarn add @yoopta/collaboration

Quick Start

Plugins, initial value and marks are passed to createYooptaEditor

import { useMemo, useEffect } from 'react';
import YooptaEditor, { createYooptaEditor, type YooptaContentValue } from '@yoopta/editor';
import Paragraph from '@yoopta/paragraph';
import Headings from '@yoopta/headings';
import { Bold, Italic, Underline, Strike, CodeMark, Highlight } from '@yoopta/marks';

const PLUGINS = [Paragraph, Headings.HeadingOne, Headings.HeadingTwo, Headings.HeadingThree];
const MARKS = [Bold, Italic, Underline, Strike, CodeMark, Highlight];

const initialValue = {} as YooptaContentValue;

const EDITOR_STYLES = {
  width: 750,
  // useful when you want to create default block by clicking on empty are
  paddingBottom: 150,
};

export default function Editor() {
  const editor = useMemo(
    () => createYooptaEditor({ plugins: PLUGINS, marks: MARKS, value: initialValue }),
    [],
  );

  return (
    <YooptaEditor
      editor={editor}
      style={EDITOR_STYLES}
      placeholder="Type / to open menu"
      onChange={(value) => console.log('onChange', value)}
    />
  );
}

Themes

The editor and plugins are headless by default. For styled block UI you can use a theme package:

• @yoopta/themes-shadcn — Shadcn UI styled components (production ready)
• @yoopta/themes-material — Material Design (in progress)

Option 1: Apply theme to all plugins

import { applyTheme } from '@yoopta/themes-shadcn';

const plugins = applyTheme([
  Paragraph,
  Callout,
  Headings.HeadingOne,
  Headings.HeadingTwo,
  Headings.HeadingThree,
]);
const editor = createYooptaEditor({ plugins, marks: MARKS });

Option 2: Apply theme UI to a single plugin

import Callout from '@yoopta/callout';
import { CalloutUI } from '@yoopta/themes-shadcn/callout';

const CalloutWithUI = Callout.extend({ elements: CalloutUI });
// Use CalloutWithUI in your plugins array

See docs/core/themes for the full concept.

Adding UI Components

All UI (toolbar, slash menu, block actions) must be children of <YooptaEditor> so they can use useYooptaEditor(). Yoopta provides ready-to-use components from @yoopta/ui:

```tsx import { useMemo, useState, useRef } from 'react'; import YooptaEditor, { createYooptaEditor, Blocks, Marks, useYooptaEditor } from '@yoopta/editor'; import { FloatingToolbar, FloatingBlockActions, BlockOptions, SlashCommandMenu } from '@yoopta/ui';

// Floating toolbar for text formatting function MyToolbar() { const editor = useYooptaEditor();

return ( {editor.formats.bold && ( Marks.toggle(editor, { type: 'bold' })} active={Marks.isActive(editor, { type: 'bold' })}> B )} ); }

// Floating block actions (plus button, drag handle) function MyFloatingBlockActions() { const editor = useYooptaEditor(); const [blockOptionsOpen, setBlockOptionsOpen] = useState(false); const dragHandleRef = useRef(null);

return ( {({ blockId }) => ( <> { if (!blockId) return; const block = Blocks.getBlock(editor, { id: blockId }); if (block) editor.insertBlock('Paragraph', { at: block.meta.order + 1, focus: true }); }}> + setBlockOptionsOpen(true)}> ⋮⋮

      <BlockOptions
        open={blockOptionsOpen}
        onOpenChange={setBlockOptionsOpen}
        anchor={dragHandleRef.current}>
        <BlockOptions.Content>{/* Block options menu items */}</BlockOptions.Content>