Skip to content
This repository has been archived by the owner on Jan 6, 2023. It is now read-only.

fex-team/ueditor

Repository files navigation

Get Started

鑒于目前 ISSUE 較多(duō)而維護時(shí)間(jiān)較少(shǎo),且在進行(xíng)後續的版本更新,目前暫時(shí)關閉 ISSUE,若社區(qū)有(yǒu)人(rén)跟進,歡迎和(hé)我們聯系。重複的問題,請(qǐng)參閱常見問題的 FAQ Wiki

重要安全通(tōng)告:

  1. commons-fileupload-1.3.1.jar 存在漏洞可(kě)能會(huì)導緻 ddos,源代碼中已經修改,使用老版本的用戶,強烈推薦升級 commons-fileupload.jar 至最新版本。(2018-04-09).
  2. UEditor 所提供的所有(yǒu)後端代碼都僅為(wèi) DEMO 作(zuò)用,切不可(kě)直接使用到生(shēng)産環境中,目前已知 php 的代碼會(huì)存在 ssrf 及文件包含漏洞,因此不再提供。

ueditor富文本編輯器(qì)介紹

UEditor是由百度web前端研發部開(kāi)發所見即所得(de)富文本web編輯器(qì),具有(yǒu)輕量,可(kě)定制(zhì),注重用戶體(tǐ)驗等特點,開(kāi)源基于MIT協議,允許自由使用和(hé)修改代碼。

1 入門(mén)部署和(hé)體(tǐ)驗

1.1 下載編輯器(qì)

  1. git clone 倉庫
  2. npm install 安裝依賴(如果沒有(yǒu)安裝 grunt , 請(qǐng)先在全局安裝 grunt)
  3. 在終端執行(xíng) grunt default

1.2 創建demo文件

解壓下載的包,在解壓後的目錄創建demo.html文件,填入下面的html代碼

<!DOCTYPE HTML>
<html lang="en-US">
<head>
	<meta charset="UTF-8">
	<title>ueditor demo</title>
</head>
<body>
	<!-- 加載編輯器(qì)的容器(qì) -->
	<script id="container" name="content" type="text/plain">這裏寫你(nǐ)的初始化內(nèi)容</script>
	<!-- 配置文件 -->
	<script type="text/javascript" src="ueditor.config.js"></script>
	<!-- 編輯器(qì)源碼文件 -->
	<script type="text/javascript" src="ueditor.all.js"></script>
	<!-- 實例化編輯器(qì) -->
	<script type="text/javascript">
	    var ue = UE.getEditor('container');
	</script>
</body>
</html>

1.3 在浏覽器(qì)打開(kāi)demo.html

如果看到了下面這樣的編輯器(qì),恭喜你(nǐ),初次部署成功!

部署成功

1.4 傳入自定義的參數(shù)

編輯器(qì)有(yǒu)很(hěn)多(duō)可(kě)自定義的參數(shù)項,在實例化的時(shí)候可(kě)以傳入給編輯器(qì):

var ue = UE.getEditor('container', {
    autoHeight: false
});

配置項也可(kě)以通(tōng)過ueditor.config.js文件修改,具體(tǐ)的配置方法請(qǐng)看[前端配置項說明(míng)](http://fex.baidu.com/ueditor/#start-config1.4 前端配置項說明(míng).md)

1.5 設置和(hé)讀取編輯器(qì)的內(nèi)容

通(tōng)getContent和(hé)setContent方法可(kě)以設置和(hé)讀取編輯器(qì)的內(nèi)容

var ue = UE.getEditor();
//對編輯器(qì)的操作(zuò)最好在編輯器(qì)ready之後再做(zuò)
ue.ready(function(){
    //設置編輯器(qì)的內(nèi)容
    ue.setContent('hello');
    //獲取html內(nèi)容,返回: <p>hello</p>
    var html = ue.getContent();
    //獲取純文本內(nèi)容,返回: hello
    var txt = ue.getContentTxt();
});

ueditor的更多(duō)API請(qǐng)看API 文檔

1.6 dev-1.5.0 版本二次開(kāi)發自定義插件注意事項

dev-1.5.0版對于插件的加載邏輯進行(xíng)了調整,但(dàn)官網對應的二次開(kāi)發功能文檔未對相應調整做(zuò)出開(kāi)發細節說明(míng),現補充如下:

除進行(xíng)原有(yǒu)配置外,還(hái)需在實例化ueditor編輯器(qì)時(shí)在 toolbars 參數(shù)數(shù)組中,加入自定義插件的 uiname,并且注意uiname必須小(xiǎo)寫,方可(kě)正确加載自定義插件。

2 詳細文檔

ueditor 官網:http://ueditor.baidu.com

ueditor API 文檔:http://ueditor.baidu.com/doc

ueditor github 地址:http://github.com/fex-team/ueditor

ueditor 第三方插件貢獻 wiki : 第三方插件貢獻規範

ueditor 貢獻代碼規範(javascript): javascript規範

3 第三方貢獻

ueditor for nodejs 參考https://github.com/netpi/ueditor

4 聯系我們

email:ueditor@baidu.com

issue:github issue