@syncfusion/ej2-blockeditor

v32.2.4

Published

3 days ago

Feature Rich Block Editor control with built in support editing, formatting content.

Downloads

24,909

0High
0Medium
0Low

syncfusionorg

essentialjs2

syncfusion-javascript

ej2 syncfusion blockeditor blocks editor notion modular-editor block-based inline-editor

JavaScript Block Editor Component

The JavaScript Block Editor is a modern, block-based editor for composing rich, structured documents. It’s ideal for document editing, knowledge bases, note-taking, and content creation tools. The editor provides an intuitive UI with mobile support and modular architecture. It offers multiple block types, inline content (mentions, links, labels), slash commands, and contextual menus, returning well-structured content models and valid HTML when needed.

⚡️ Quick Start

The JavaScript Block Editor is easy to set up. Install the package, add a container, import the editor, and initialize it.

Installation

Install via npm:

npm install @syncfusion/ej2-blockeditor

 ### Add the Editor Element

 In your HTML file, add a target element:

```html
<!DOCTYPE html>
<html>
  <head>
    <!-- Include the required CSS for the Block Editor in your build -->
  </head>
  <body>
    <!-- Your Block Editor container -->
    <div id="blockEditor"></div>
  </body>
</html>

Import the Module

Import the Block Editor module into your application:

// Example import. Adjust based on your bundler/exports.
import { BlockEditor } from '@syncfusion/ej2-blockeditor';

Initialize the Editor

Create an instance of the Block Editor and append it to a target element:

const editor = new BlockEditor({
  height: '500px'
});

editor.appendTo('#blockEditor');

Run the Application

Now, open your project in a browser, and the Block Editor will be displayed! 🚀

✨ Key features

Multiple block types: Includes Heading levels 1-4, Table, Paragraph, Table, Lists, Checklist, Quote, Callout, Divider, Code block, and more.
Slash commands: Interactive / commands to insert or transform content blocks, with filtering and keyboard shortcuts.
Drag and drop: Reorder blocks effortlessly with built-in drag-and-drop support.
Rich text formatting: Apply styles such as Bold, Italic, Underline, Strikethrough, Uppercase and more.
Action menu: Perform block-level operations such as Move, Delete, and Duplicate.
Contextmenu support: Right-click context menus for quick block actions.
Inline content support: Insert inline elements like Links, Labels and Mention directly within blocks.
Undo/Redo operations: Undo and redo support for the user interactions.
Events for Customization: The Block Editor includes a rich set of events such as block addition, removal, update, selection change, command execution, paste, and mention selection allowing developers to customize and extend functionality easily.
Accessibility & WCAG 2.0 Compliance: Accessibility support for assistive technologies and keyboard navigation.
Keyboard Navigation: Navigate and manage blocks efficiently using intuitive keyboard shortcuts for a faster editing experience.

🛠️ Supported frameworks

Input controls are also offered in following list of frameworks.

| Angular | React | Vue | ASP.NET Core | ASP.NET MVC | | :-----: | :-----: | :-----: | :-----: | :-----: |

🏗️ Showcase samples

Expanse Tracker - Source, Live Demo
Loan Calculator - Source, Live Demo
Cloud Pricing - Live Demo

📚 Resources

🤝 Support

Product support is available through following mediums.

Support ticket - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
Community forum
GitHub issues
Request feature or report bug
Live chat

🔄 Changelog

Check the changelog here. Get minor improvements and bug fixes every week to stay up to date with frequent updates.

⚖️ License and copyright

This is a commercial product and requires a paid license for possession or use. Syncfusion’s licensed software, including this component, is subject to the terms and conditions of Syncfusion's EULA. To acquire a license for 140+ JavaScript UI controls, you can purchase or start a free 30-day trial.

A free community license is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.

See LICENSE FILE for more info.