BlockNote

A "Notion-style" block-based extensible text editor built on top of Prosemi...

Rich text editorReact
TypeCellOS/BlockNotewww.blocknotejs.org/@blocknote/core

README

TypeCell


Welcome to BlockNote! The open source Block-Based
rich text editor. Easily add a modern text editing experience to your app.


Discord Matrix


    Homepage
-
    Introduction
 -
    Documentation


Live demo


Play with the editor @ https://blocknote-main.vercel.app/.

(Source in examples/editor)

Example code (React)


npm version

  1. ```typescript
  2. import { BlockNoteView, useBlockNote } from "@blocknote/react";
  3. import "@blocknote/core/style.css";

  5. function App() {
  6.   const editor = useBlockNote({
  7.     onEditorContentChange: (editor) => {
  8.       // Log the document to console on every update
  9.       console.log(editor.getJSON());
  10.     },
  11.   });

  13.   return <BlockNoteView editor={editor} />;
  14. }
  15. ```

@blocknote/react comes with a fully styled UI that makes it an instant, polished editor ready to use in your app.

If you prefer to create your own UI components (menus), or don't want to use React, you can use @blocknote/core (_advanced_, see docs).

Features


BlockNote comes with a number of features and components to make it easy to embed a high-quality block-based editor in your app:

Animations:



Helpful placeholders:



Drag and drop blocks:



Nesting / indentation with tab and shift+tab:



Slash (/) menu:



Format menu:



Real-time collaboration:



Feedback 🙋‍♂️🙋‍♀️


We'd love to hear your thoughts and see your experiments, so come and say hi on Discord or Matrix.

Contributing 🙌


See CONTRIBUTING.md for more info and guidance on how to run the project (TLDR: just usenpm start).

Directory structure:

  1. ```
  2. blocknote
  3. ├── packages/core       - The core of the editor
  4. ├── packages/react      - The main library for use in React apps
  5. ├── examples/editor     - Example React app that embeds the editor
  6. ├── examples/vanilla    - An advanced example if you don't want to use React or want to build your own UI components
  7. └── tests               - Playwright end to end tests
  8. ```

The codebase is automatically tested using Vitest and Playwright.

Credits ❤️


BlockNote builds directly on two awesome projects; Prosemirror by Marijn Haverbeke and Tiptap. Consider sponsoring those libraries when using BlockNote: Prosemirror, Tiptap.

BlockNote is built as part of TypeCell. TypeCell is proudly sponsored by the renowned NLNet foundation who are on a mission to support an open internet, and protect the privacy and security of internet users. Check them out!

NLNet

Hosting and deployments powered by Vercel:

NLNet