在線代碼編輯器 CODEMIRROR 配置說明

轉自:http://www.hyjiacan.com/codemirror-config/

CodeMirror是一款在線的支持語法高亮的代碼編輯器。官網： http://codemirror.net/

下載後，解壓開獲得的文件夾中，lib下是放的是核心庫和核心css，mode下放的是各類支持語言的語法定義，theme目錄下是支持的主題樣式。通常在開發中，添加lib下的引用和mode下的引用就夠了。

 

使用示例

首先，要引用是 lib 目錄下的 codemirror.js，還有一個就是同目錄下的codemirror.css 文件

1 2	< script src = "lib/codemirror.js" ></ script > < link rel = "stylesheet" href = "/lib/codemirror.css" >

接下來要引用的就是在mode目錄下編輯器中要編輯的語言對應的js文件，下面以js文件爲例：

1	< script src = "mode/javascript/javascript.js" ></ script >

引用的文件用於支持對應語言的語法高亮。

而後，調用腳本以建立編輯器：

1	var myCodeMirror = CodeMirror(document.body);

這裏的調用會在body中添加編輯器，這裏由於直接在上面引用了javascript.js，因此這個編輯器會對javascript的關鍵字高亮顯示。
想要高級一點，給編輯器添加一些元素，也能夠經過傳入配置參數來實現。

1 2 3

var myCodeMirror = CodeMirror(document.body,{ lineNumbers: true });

這樣，就給編輯器添加了行號。

上面說的是實現編輯器的最簡單的方式，而後在實際項目中，通常都不會直接把body做爲編輯器的容器。而最經常使用的，是使用textarea。
要把 textarea 實現成一個支持高亮的編輯器，CodeMirror 提供了很是簡單的方法：

1	< textarea id = "editor" name = "editor" ></ textarea >

1 2 3 4 5

var myTextarea = document.getElementById( 'editor' ); var CodeMirrorEditor = CodeMirror.fromTextArea(myTextarea, {      mode: "text/javascript" , lineNumbers: true });

配置說明

在使用CodeMirror的時候，不論是直接使用 CodeMirror() 仍是使用 fromTextArea() ，均可以經過傳遞第二個參數來配置編輯器。
使用方法以下：

1 2 3

var myCodeMirror = CodeMirror(el, {      // options... });

或者

1 2 3

var myCodeMirror = CodeMirror.fromTextArea(el, {      // options... });

options 可使用的參數

CodeMirror函數和它的fromTextArea方法均可以使用一個配置對象做爲第二個參數。

value: string | CodeMirror.Doc
編輯器的初始值（文本），能夠是字符串或者CodeMirror文檔對象(不一樣於HTML文檔對象)。

mode: string | object
通用的或者在CodeMirror中使用的與mode相關聯的mime，當不設置這個值的時候，會默認使用第一個載入的mode定義文件。通常地，會使用關聯的mime類型來設置這個值；除此以外，也可使用一個帶有name屬性的對象來做爲值（如：{name: 「javascript」, json: true}）。能夠經過訪問CodeMirror.modes和CodeMirror.mimeModes獲取定義的mode和MIME。

lineSeparator: string|null
明確指定編輯器使用的行分割符（換行符）。默認（值爲null）狀況下，文檔會被 CRLF(以及單獨的CR, LF)分割，單獨的LF會在全部的輸出中用做換行符（如：getValue）。當指定了換行字符串，行就只會被指定的串分割。

theme: string
配置編輯器的主題樣式。要使用主題，必須保證名稱爲 .cm-s-[name] (name是設置的theme的值)的樣式是加載上了的。固然，你也能夠一次加載多個主題樣式，使用方法和html和使用類同樣，如： theme: foo bar，那麼此時須要cm-s-foo cm-s-bar這兩個樣式都已經被加載上了。

indentUnit: integer
縮進單位，值爲空格數，默認爲2 。

 

 

smartIndent: boolean
自動縮進，設置是否根據上下文自動縮進（和上一行相同的縮進量）。默認爲true。

tabSize: integer
tab字符的寬度，默認爲4 。

indentWithTabs: boolean
在縮進時，是否須要把 n*tab寬度個空格替換成n個tab字符，默認爲false 。

electricChars: boolean
在輸入可能改變當前的縮進時，是否從新縮進，默認爲true （僅在mode支持縮進時有效）。

specialChars: RegExp
須要被佔位符(placeholder)替換的特殊字符的正則表達式。最經常使用的是非打印字符。默認爲：/[\u0000-\u0019\u00ad\u200b-\u200f\u2028\u2029\ufeff]/。

specialCharPlaceholder: function(char) → Element
這是一個接收由specialChars選項指定的字符做爲參數的函數，此函數會產生一個用來顯示指定字符的DOM節點。默認狀況下，顯示一個紅點（•），這個紅點有一個帶有前面特殊字符編碼的提示框。

rtlMoveVisually: boolean
Determines whether horizontal cursor movement through right-to-left (Arabic, Hebrew) text is visual (pressing the left arrow moves the cursor left) or logical (pressing the left arrow moves to the next lower index in the string, which is visually right in right-to-left text). The default is false on Windows, and true on other platforms.（這段徹底不曉得搞啥子鬼）

keyMap: string
配置快捷鍵。默認值爲default，即 codemorrir.js 內部定義。其它在key map目錄下。

extraKeys: object
給編輯器綁定與前面keyMap配置不一樣的快捷鍵。

lineWrapping: boolean
在長行時文字是換行(wrap)仍是滾動(scroll)，默認爲滾動(scroll)。

lineNumbers: boolean
是否在編輯器左側顯示行號。

firstLineNumber: integer
行號從哪一個數開始計數，默認爲1 。

lineNumberFormatter: function(line: integer) → string
使用一個函數設置行號。

gutters: array<string>
用來添加額外的gutter（在行號gutter前或代替行號gutter）。值應該是CSS名稱數組，每一項定義了用於繪製gutter背景的寬度（還有可選的背景）。爲了能明確設置行號gutter的位置（默認在全部其它gutter的右邊），也能夠包含CodeMirror-linenumbers類。類名是用於傳給setGutterMarker的鍵名(keys)。

 

 

fixedGutter: boolean
設置gutter跟隨編輯器內容水平滾動（false）仍是固定在左側（true或默認）。

scrollbarStyle: string
設置滾動條。默認爲」native」，顯示原生的滾動條。核心庫還提供了」null」樣式，此樣式會徹底隱藏滾動條。Addons能夠設置更多的滾動條模式。

coverGutterNextToScrollbar: boolean
當fixedGutter啓用，而且存在水平滾動條時，在滾動條最左側默認會顯示gutter，當此項設置爲true時，gutter會被帶有CodeMirror-gutter-filler類的元素遮擋。
inputStyle: string
選擇CodeMirror處理輸入和焦點的方式。核心庫定義了textarea和contenteditable輸入模式。在移動瀏覽器上，默認是contenteditable，在桌面瀏覽器上，默認是textarea。在contenteditable模式下對IME和屏幕閱讀器支持更好。

readOnly: boolean|string
編輯器是否只讀。若是設置爲預設的值 「nocursor」，那麼除了設置只讀外，編輯區域還不能得到焦點。

showCursorWhenSelecting: boolean
在選擇時是否顯示光標，默認爲false。

lineWiseCopyCut: boolean
啓用時，若是在複製或剪切時沒有選擇文本，那麼就會自動操做光標所在的整行。

undoDepth: integer
最大撤消次數，默認爲200（包括選中內容改變事件） 。

historyEventDelay: integer
在輸入或刪除時引起歷史事件前的毫秒數。

tabindex: integer
編輯器的tabindex。

autofocus: boolean
是否在初始化時自動獲取焦點。默認狀況是關閉的。可是，在使用textarea而且沒有明確指定值的時候會被自動設置爲true。

低級選項

下面的選項僅用於一些特殊狀況。

dragDrop: boolean
是否容許拖放，默認爲true。

allowDropFileTypes: array<string>
默認爲null。當設置此項時，只接收包含在此數組內的文件類型拖入編輯器。文件類型爲MIME名稱。

cursorBlinkRate: number
光標閃動的間隔，單位爲毫秒。默認爲530。當設置爲0時，會禁用光標閃動。負數會隱藏光標。

cursorScrollMargin: number
當光標靠近可視區域邊界時，光標距離上方和下方的距離。默認爲0 。

cursorHeight: number
光標高度。默認爲1，也就是撐滿行高。對一些字體，設置0.85看起來會更好。

resetSelectionOnContextMenu: boolean
設置在選擇文本外點擊打開上下文菜單時，是否將光標移動到點擊處。默認爲true。

workTime, workDelay: number
經過一個假的後臺線程高亮 workTime 時長，而後使用 timeout 休息 workDelay 時長。默認爲200和300 。（徹底不懂這個功能是在說啥）

pollInterval: number
指明CodeMirror向對應的textarea滾動（寫數據）的速度（得到焦點時）。大多數的輸入都是經過事件捕獲，可是有的輸入法（如IME）在某些瀏覽器上並不會生成事件，因此使用數據滾動。默認爲100毫秒。

flattenSpans: boolean
默認狀況下，CodeMirror會將使用相同class的兩個span合併成一個。經過設置此項爲false禁用此功能。

addModeClass: boolean
當啓用時（默認禁用），會給每一個標記添加額外的表示生成標記的mode的以cm-m開頭的CSS樣式類。例如，XML mode產生的標記，會添加cm-m-xml類。

maxHighlightLength: number
當須要高亮很長的行時，爲了保持響應性能，當到達某些位置時，編輯器會直接將其餘行設置爲純文本(plain text)。默認爲10000，能夠設置爲Infinity來關閉此功能。

viewportMargin: integer指定當前滾動到視圖中內容上方和下方要渲染的行數。這會影響到滾動時要更新的行數。一般狀況下應該使用默認值10。能夠設置值爲Infinity始終渲染整個文檔。注意：這樣設置在處理大文檔時會影響性能。