fex-team/ueditor

★ 6,772JavaScriptAudience · developerComplexity · 2/5LicenseSetup · easy

Mindmap

mindmap
  root((repo))
    What it does
      Rich text editor
      Browser embedded
      HTML output
    Setup
      Script tag init
      Config object
      Single function call
    API
      getContent HTML
      setContent HTML
      getContentTxt plain
    Notes
      MIT license
      Baidu FEX team
      Chinese README

mindmap root((repo)) What it does Rich text editor Browser embedded HTML output Setup Script tag init Config object Single function call API getContent HTML setContent HTML getContentTxt plain Notes MIT license Baidu FEX team Chinese README

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Embed a rich text editor into a CMS so content creators can format articles with bold, italics, and images without writing HTML.

USE CASE 2

Read the formatted HTML from the editor using getContent and save it to a database when a user submits a form.

USE CASE 3

Add a formatted text input area to a web app by dropping in two script tags and calling the initialization function.

USE CASE 4

Retrieve plain text from the editor using getContentTxt to display a preview or word count without HTML tags.

Tech stack

JavaScriptHTMLCSS

Getting it running

Difficulty · easy Time to first run · 5min

Download the package from the official site and add two script tags, no npm or build step required.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice, MIT license.

In plain English

UEditor is a browser-based rich text editor developed by Baidu's web frontend team. A rich text editor is the kind of text input area where you can apply bold, italics, insert images, and format content visually, similar to what you see in email clients or content management systems, rather than writing raw HTML or plain text. The editor is designed to be embedded in a web page with a few lines of JavaScript. Setup involves downloading the package from the official site, adding a script tag for the configuration file and one for the editor itself, and calling a single initialization function that targets a container element on the page. Once initialized, the editor appears in place of that container with a toolbar and editing area ready to use. Content can be read from or written to the editor programmatically using getContent and setContent methods, which return and accept HTML. A separate method, getContentTxt, returns the content as plain text with HTML tags stripped out. Most behavior, such as whether the editor auto-adjusts its height, can be controlled by passing a configuration object at initialization time or by editing the configuration file. The project is released under the MIT license, which allows free use and modification. The README is brief and written mainly in Chinese. It links to a separate documentation site with API references and more detailed guides. The project was created and maintained by Baidu's FEX team.

Copy-paste prompts

Prompt 1

I want to embed UEditor into my HTML page as a rich text input. Show me the two script tags I need, the container element, and the initialization call.

Prompt 2

How do I read the HTML content from a UEditor instance when the user clicks a submit button, and how do I set the initial content when the page loads?

Prompt 3

I want to configure UEditor so it auto-adjusts its height to fit the content rather than using a fixed height. Which config option controls that?

Prompt 4

How do I integrate UEditor into a form so the rich text content is submitted as a hidden field along with the rest of the form data?

Open on GitHub → Explain another repo

← fex-team on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.