第一步:下載並引用
在這里下載並解壓最新版的 Simditor 文件,然后在頁面中引入這些文件:
其中,
- Simditor基於 jQuery 開發,
jquery.js
是必需的; - font-awesome.css 是一個圖片字體 icon 庫,Simditor 基於它來定義工具欄的按鈕樣式。為了讓 icon 能夠正常顯示,需要將 font 文件(fontawesome-webfont.xxx)放到正確的路徑里:
../fonts/
(如果把 font-awsome.css 放在styles
文件夾,那么就應該把 font 文件放在跟styles
同級的fonts
文件夾)。另外,如果想自定義工具欄按鈕的樣式就可以不必引用font-awesome.css
; - module.js 是彩程內部使用的 CoffeeScript 組件抽象類,Simditor 基於這個類開發;
- uploader.js 是一個與 UI 無關的上傳邏輯,如果你的項目不需要上傳附件,那么可以不引用這個文件。
第二步,初始化配置
在使用 Simditor 的 HTML 頁面里應該有一個對應的 textarea
文本框,例如:
<textarea id="editor" placeholder="這里輸入內容" autofocus></textarea>
我們需要在這個頁面的腳本里初始化 Simditor:
var editor = new Simditor({ textarea: $('#editor') });
textarea
是初始化 Simditor 的必需選項,可以接受 jQuery Object、HTML Element 或者 Selector String。另外,Simditor 還支持這些可選 option:
placeholder
(默認值:'')編輯器的 placeholder,如果為空 Simditor 會取 textarea 的 placeholder 屬性;toolbar
(默認值:true)是否顯示工具欄按鈕;toolbarFloat
(默認值:true)是否讓工具欄按鈕在頁面滾動的過程中始終可見;toolbarHidden
(默認值:false)是否隱藏工具欄,隱藏后toolbarFloat
會失效;defaultImage
(默認值:'images/image.png')編輯器插入混排圖片時使用的默認圖片;tabIndent
(默認值:true)是否在編輯器中使用tab
鍵來縮進;params
(默認值:{})鍵值對,在編輯器中增加 hidden 字段(input:hidden),通常用於生成 form 表單的默認參數;upload
(默認值:false)false 或者鍵值對,編輯器上傳本地圖片的配置,常用的屬性有url
和params
;pasteImage
(默認值:false)是否允許粘貼上傳圖片,依賴upload
選項,僅支持 Firefox 和 Chrome 瀏覽器。
更詳細的配置說明可以參考 Simditor 的配置文檔。配置完成之后刷新頁面,Simditor 應該就可以正確加載了。
最后,自定義樣式和交互
每個項目都有不同的設計風格,大多數時候我們需要修改 Simditor 的樣式,讓它的樣式跟項目的風格相符。
simditor.css
是通過 Sass 自動生成的代碼,所以推薦大家修改 simditor.scss
,然后再重新生成css代碼。
.editor-style
選擇符下面的樣式,是 Simditor 輸出 HTML 的中文排版樣式,大家可以根據自己項目的情況進行調整。另外,如果不想使用 font-awesome.css 來實現工具欄按鈕的 icon,可以將 font-awesome.css
去掉,然后增加 .toolbar-item-[button name]
選擇符來自定義按鈕樣式。
有的項目有一些特殊的交互需求,例如自動保存功能或者 @ 人的功能,我們可以基於 Simple Module 來給 Simditor 編寫擴展。關於編寫擴展更詳細的介紹請參考教程《編寫擴展》。
原文鏈接地址:http://simditor.tower.im/tours/tour-usage.html