Skip to main content

Prerequisites

  • Node.js 18+
  • React 18+

Install

slate, slate-react, and slate-dom are peer dependencies required by @yoopta/editor.

Basic Editor

If you see an editor with placeholder text, you’re all set. Now let’s make it useful.

Add Plugins

Install the plugins you need:
Pass them to createYooptaEditor:
See Available Plugins for the full list — image, video, table, accordion, embed, and more.

Add a Theme

Plugins are headless by default. To get styled block UI, apply a theme:
Apply to all plugins:
Or apply to a single plugin:
See Themes for all available theme exports.

Add UI Components

Toolbar, slash menu, and block actions are provided by @yoopta/ui. Add them as children of YooptaEditor:
See UI Components for all available components and customization.

Add Marks

Marks handle text formatting. All available marks:

Full Example

Everything together — plugins, theme, marks, and UI:

Next Steps

Core Concepts

Understand blocks, elements, and the editor API

Explore Plugins

Browse all 20+ available plugins

UI Components

Customize toolbar, menus, and block actions

Live Examples

See what’s possible with Yoopta Editor

Troubleshooting

Make sure you’ve installed all three Slate peer dependencies:
Yoopta Editor ships its own type definitions. Make sure you’re using TypeScript 4.8+ and that @yoopta/editor is properly installed.
Need help? Join our Discord community or check GitHub Issues.