經過使用KE.show(config)方法便可將編輯器添加到文檔中。下面是一段源碼:php
KE.show = function(args) {
KE.init(args);
KE.event.ready(function() { KE.create(args.id); });
};css
從源碼中能夠看出,有兩種使用編輯器的方法:html
法一:KE.show(config);json
法二:KE.init(config);KE.create(id);數組
·不管使用哪一種方式使用KindEditor編輯器,都必須進行參數配置;服務器
·能夠在KE.show()和KE.init()方法中傳遞配置參數config;dom
·配置參數config是一個對象,通常使用字面量對象;編輯器
·其中,id參數是惟一必須進行配置的,其餘參數能夠省略。函數
參數設置例子工具
KE.show({
id : "content_1",
width : "70%", //編輯器的寬度爲70%
height : "200px", //編輯器的高度爲100px
filterMode : false, //不會過濾HTML代碼
resizeMode : 1 //編輯器只能調整高度
});
配置參數
一、id
TEXTAREA輸入框的ID,必須設置。
數據類型:String
二、items
配置編輯器的工具欄,其中"-"表示換行,"|"表示分隔符。
數據類型:Array
默認值:
['source', '|', 'fullscreen', 'undo', 'redo', 'print', 'cut', 'copy', 'paste',
'plainpaste', 'wordpaste', '|', 'justifyleft', 'justifycenter', 'justifyright',
'justifyfull', 'insertorderedlist', 'insertunorderedlist', 'indent', 'outdent', 'subscript',
'superscript', '|', 'selectall', '-',
'title', 'fontname', 'fontsize', '|', 'textcolor', 'bgcolor', 'bold',
'italic', 'underline', 'strikethrough', 'removeformat', '|', 'image',
'flash', 'media', 'advtable', 'hr', 'emoticons', 'link', 'unlink', '|', 'about']
三、width
編輯器的寬度,能夠設置px或%,比TEXTAREA輸入框樣式表寬度優先度高。
數據類型:String
默認值:TEXTAREA輸入框的寬度
注: 3.2版本開始支持。
四、height
編輯器的高度,只能設置px,比TEXTAREA輸入框樣式表高度優先度高。
數據類型:String
默認值:TEXTAREA輸入框的高度
注: 3.2版本開始支持。
五、minWidth
數據類型:Int
指定編輯器最小寬度,單位爲px。
默認值:200
六、minHeight
數據類型:Int
指定編輯器最小高度,單位爲px。
默認值:100
七、filterMode
數據類型:Boolean
true時過濾HTML代碼,false時容許輸入任何代碼。
默認值:false
注: 3.4之前版本的filterMode默認值爲true。
八、htmlTags
指定要保留的HTML標記和屬性。哈希數組的key爲HTML標籤名,value爲HTML屬性數組,"."開始的屬性表示style屬性。
數據類型:Object
默認值:
{
font : ['color', 'size', 'face', '.background-color'],
span : ['style'],
div : ['class', 'align', 'style'],
table:['class', 'border', 'cellspacing', 'cellpadding', 'width', 'height', 'align', 'style'],
'td,th':['class', 'align', 'valign', 'width', 'height',
'colspan', 'rowspan', 'bgcolor', 'style'],
a : ['class', 'href', 'target', 'name', 'style'],
embed : ['src', 'width', 'height', 'type', 'loop', 'autostart', 'quality',
'style', 'align', 'allowscriptaccess', '/'],
img : ['src', 'width', 'height', 'border', 'alt', 'title', 'align', 'style', '/'],
hr : ['class', '/'],
br : ['/'],
'p,ol,ul,li,blockquote,h1,h2,h3,h4,h5,h6' : ['align', 'style'],
'tbody,tr,strong,b,sub,sup,em,i,u,strike' : []
}
注:filterMode爲true時有效。3.4版本開始屬性可設置style,保留全部inline樣式。
九、resizeMode
2或1或0,2時能夠拖動改變寬度和高度,1時只能改變高度,0時不能拖動。
數據類型:Int
默認值:2
十、skinType
風格類型,default或tinymce。
數據類型:String
默認值:default
注:3.4之前版本和3.4.1版本開始默認值爲default,3.4版本的默認值爲oxygen。
十一、wyswygMode
可視化模式或代碼模式
數據類型:Boolean
默認值:true
十二、cssPath
指定編輯器iframe document的CSS,用於設置可視化區域的樣式。
數據類型:String或Array
默認值:空
注:3.4.1版本開始可指定多個CSS文件。例如:cssPath : ['a.css', 'b.css']
1三、skinsPath
指定編輯器的skins目錄,skins目錄存放風格的css文件和gif圖片。
數據類型:String
默認值:KE.scriptPath + 'skins/'
1四、pluginsPath
指定編輯器的plugins目錄。
數據類型:String
默認值:KE.scriptPath + 'plugins/'
1五、minChangeSize
undo/redo文字輸入最小變化長度,當輸入的文字變化小於這個長度時不會添加到undo堆棧裏。
數據類型:Int
默認值:5
1六、loadStyleMode
true時自動加載編輯器的CSS。
數據類型:Boolean
默認值:true
注: 3.4版本開始支持。
1七、urlType
改變站內本地URL,可設置空、relative、absolute、domain。
空爲不修改URL,relative爲相對路徑,absolute爲絕對路徑,domain爲帶域名的絕對路徑。
數據類型:String
默認值:空
注: 3.4版本開始支持,3.4.1版本開始默認值爲空。
1八、newlineTag
設置回車換行標籤,可設置p、br。
數據類型:String
默認值:br
注: 3.4版本開始支持。
1九、afterCreate
設置編輯器建立後執行的回調函數。
數據類型:Function
默認值:無
20、afterDialogCreate
設置彈出浮動框建立後執行的回調函數。
數據類型:Function
默認值:無
注: 3.4.3版本開始支持。
2一、allowUpload
true或false,true時顯示上傳圖片標籤。
數據類型:Boolean
默認值:true
注: 3.4版本開始支持。
2二、allowFileManager
true或false,true時顯示瀏覽服務器圖片功能。
數據類型:Boolean
默認值:false
注: 3.4版本開始支持。
2三、referMethod
設置referMethod後上傳圖片的POST參數裏有referMethod。
數據類型:String
默認值:空
注: 3.4版本開始支持。
2四、dialogAlignType
設置彈出框(dialog)的對齊類型,可設置page和空。
指定page時按當前頁面居中,指定空時按編輯器居中。
數據類型:String
默認值:page
注: 3.4.1版本開始支持。
2五、imageUploadJson
指定上傳圖片的服務器端程序。
數據類型:String
默認值:../../php/upload_json.php
注: 3.4.1版本開始支持。
2六、fileManagerJson
指定瀏覽遠程圖片的服務器端程序。
數據類型:String
默認值:../../php/file_manager_json.php
注: 3.4.1版本開始支持。
2七、autoSetDataMode
true或false。
true時自動將編輯器內容設置到原來的textarea,也就是每次輸入內容就執行KE.util.setData函數。
數據類型:Boolean
默認值:true
注: 3.5版本開始支持。打開autoSetDataMode模式後會下降輸入性能,理想的作法是關閉autoSetDataMode,提交數據前執行KE.util.setData。
2八、afterSetData
自動執行KE.util.setData後執行的回調函數,autoSetDataMode爲true時有效。
數據類型:Function
默認值:無
注: 3.5版本開始支持。
2九、shadowMode
true或false,true時彈出層顯示陰影。
數據類型:Boolean
默認值:true
注: 3.5版本開始支持。
30、allowPreviewEmoticonstrue或false,true時鼠標放在表情上能夠預覽表情。 數據類型:Boolean 默認值:true 注: 3.5版本開始支持。