35.1.37 • Published 5d ago

@syncfusion/ej2-documenteditor

Licence

SEE LICENSE IN license

Version

35.1.37

Deps

Size

98.8 MB

Vulns

Weekly

Stars

448

Summary Dependency Versions

JavaScript DOCX Editor Control

The JavaScript DOCX Editor control is a feature rich UI component with document editing capabilities like Microsoft Word. Also known as the document editor, it is used to create, edit, view, and print Word documents. It provides all the common Word processing features including editing text, formatting content, resizing images and tables, finding and replacing text, bookmarks, tables of contents, track changes, commenting, restrict editing, printing, importing and exporting Word documents.

An example DOCX Editor server-side Web API projects for ASP.NET MVC, ASP.NET Core, and Java is available in GitHub which contains all the mandatory Web APIs for opening Word documents, paste with formatting, restrict editing, spell-checking, and saving documents other than SFDT/DOCX format. Apart from these operations, all the user interactions and editing operations run purely in the client-side provides much faster editing experience to the users.

Syncfusion provides a predefined DOCX Editor server docker image targeting ASP.NET Core 2.1 framework. You can directly pull this docker image and deploy it in server on the go. You can also create own docker image by customizing the existing docker project from GitHub.

Getting Started . Online demos . Learn more

JavaScript DOCX Editor Control

Trusted by the world's leading companies

Using this package with an AI coding agent

Before generating Syncfusion code, ask your AI coding agent to run the Syncfusion setup using the following prompt:
Set up this project for Syncfusion before generating code. Fetch
and follow the official instructions at https://ai.syncfusion.com/,
then report the detected platform, installed skill pack, MCP 
status, and any required licensing action.
The setup detects your project’s platform and loads the appropriate Syncfusion skill pack. No Syncfusion account or MCP key is required to install or read Syncfusion agent skills.

Platform reference: https://ai.syncfusion.com/docx-editor-sdk/llms.txt

Setup

To install Document Editor and its dependent packages, use the following command.

npm install @syncfusion/ej2-documenteditor

Add DOCX Editor control

To add the JavaScript Document editor control in the application, place the following code in the App.ts file.

import { DocumentEditorContainer, Toolbar } from '@syncfusion/ej2-documenteditor';

DocumentEditorContainer.Inject(Toolbar);

let documenteditor: DocumentEditorContainer = new DocumentEditorContainer({ enableToolbar: true, height: '390px', serviceUrl: 'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/'});

documenteditor.appendTo('#DocumentEditor');

The web API ('https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/') is created specifically for our online demos. You should host web API on your side, refer the web service documentation for more information.

Add an HTML div element to act as the DocumentEditorContainer control in index.html using the following code.

<!DOCTYPE html>
<html lang="en">
<head>
    <title>Essential JS 2</title>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" />
    <meta name="description" content="Essential JS 2" />
    <meta name="author" content="Syncfusion" />
    <link rel="shortcut icon" href="resources/favicon.ico" />
    <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />

    <!--style reference from app-->
    <link href="/styles/styles.css" rel="stylesheet" />

    <!--system js reference and configuration-->
    <script src="node_modules/systemjs/dist/system.src.js" type="text/javascript"></script>
    <script src="system.config.js" type="text/javascript"></script>
</head>
<body>
    <!--Element which will render as DocumentEditorContainer -->
    <div id="DocumentEditor"></div>
</body>
</html>

Supported frameworks

The JavaScript DOCX Editor (Document Editor) control is also offered in the following list of frameworks.

Angular	React	Vue	ASP.NET Core	ASP.NET MVC

Showcase samples

Expense Tracker - Source, Live Demo
Loan Calculator - Source, Live Demo

Key features

Document Authoring - Allows to create a document with supported elements and formatting options.
- Supported elements - Supports document elements like text, inline image, table, hyperlink, fields, bookmark, table of contents, footnote and endnote, section, header, and footer.
- Styles - Supports character and paragraph styles.
- Editing - Supports all the common editing and formatting operations.
- History - Supports options to perform undo redo operations.
- Find and replace - Provides support to find and replace text within the document.
- Track changes - Suppports tracking the content insertion and deletion.
- Commenting - Supports adding a comment, replying to an existing comment or mark as resolved and more.
- Form filling - Supports designing fillable forms in Word document and fill the forms.
- Restrict editng - Supports restricting edit permission for a region in Word document and control what type of changes can be made to the document.
Export - Provides the options to export the documents in the client-side as Syncfusion Document Text (*.sfdt) and Word document (*.docx). With server-side library, exporting as other formats can be achieved.
Import - Provides the options to import the native Syncfusion Document Text (*.sfdt) format documents in the client-side. With server-side library, importing other formats can be achieved.
Print - Provides the options to print the documents.
Clipboard - Provides support to cut, copy, and paste rich text contents within the component. Also allows pasting simple text from other applications. Paste rich text from other applications using server-side library.
User interface - Provides intuitive user friendly interface to perform various operations.
- Context menu - Provides context menu.
- Dialog - Provides dialog for inserting elements such as hyperlink, table and formatting such as font, paragraph, list, style, table.
- Options pane - Provides options pane to perform find and replace operations.

Resources

Support

Product support is available through the 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 licensed software, including this component, is subject to the terms and conditions of Syncfusion 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.

Keywords

ej2 web-components syncfusion documenteditor document-editor word-editor