@bhsd/codemirror-mediawiki 2.9.5 → 2.11.0

package/README.md

@@ -16,6 +16,7 @@
 	- [extraKeys](#extrakeys)
 	- [getLinter](#getlinter)
 	- [getNodeAt](#getnodeat)
+	- [initialize](#initialize)
 	- [lint](#lint)
 	- [localize](#localize)
 	- [prefer](#prefer)
@@ -30,6 +31,7 @@
 	- [replaceSelections](#replaceselections)
 - [Extensions](#extensions)
 	- [allowMultipleSelections](#allowmultipleselections)
+	- [autocompletion](#autocompletion)
 	- [bracketMatching](#bracketmatching)
 	- [closeBrackets](#closebrackets)
 	- [highlightActiveLine](#highlightactiveline)
@@ -39,6 +41,7 @@
 	- [escape](#escape)
 	- [codeFolding](#codefolding)
 	- [tagMatching](#tagmatching)
+	- [useMonaco](#usemonaco)
 
 </details>
 
@@ -86,6 +89,7 @@ const {CodeMirror6} = await import('https://unpkg.com/@bhsd/codemirror-mediawiki
 **param**: `HTMLTextAreaElement` the textarea element to be replaced by CodeMirror  
 **param**: `string` the language mode to be used, default as plain text  
 **param**: `unknown` the optional language configuration  
+**param**: `boolean` whether to initialize immediately, default as true  
 
 ```js
 const cm = new CodeMirror6(textarea); // plain text
@@ -128,7 +132,7 @@ The current language mode, read-only.
 <details>
 	<summary>Expand</summary>
 
-**type**: [`EditorView`](https://codemirror.net/6/docs/ref/#view.EditorView)  
+**type**: [`EditorView | undefined`](https://codemirror.net/6/docs/ref/#view.EditorView)  
 The CodeMirror EditorView instance, read-only.
 
 </details>
@@ -202,6 +206,22 @@ const tree = cm.getNodeAt(0);
 
 </details>
 
+## initialize
+
+<details>
+	<summary>Expand</summary>
+
+*version added: 2.11.0*
+
+**param**: `unknown` the optional language configuration  
+Initialize the editor.
+
+```js
+cm.initialize();
+```
+
+</details>
+
 ## lint
 
 <details>
@@ -430,9 +450,9 @@ Allow multiple selections.
 
 ## autocompletion
 
-*version added: 2.5.1*
+*version added: 2.10.0*
 
-Provide autocompletion for the MediaWiki mode.
+Provide autocompletion for MediaWiki, CSS and JavaScript modes.
 
 ## bracketMatching
 
@@ -477,7 +497,7 @@ Key bindings:
 
 ## codeFolding
 
-*version added: 2.3.0*
+*version added: 2.10.0*
 
 Fold template parameters.
 
@@ -493,3 +513,9 @@ Key bindings:
 *version added: 2.4.1*
 
 Matched or unmatched tags are highlighted in cyan or dark red when the cursor is inside.
+
+## useMonaco
+
+*version added: 2.11.0*
+
+Use the Monaco editor instead of the CodeMirror editor.

package/dist/codemirror.d.ts

@@ -14,7 +14,7 @@ export type LintSource = (doc: Text) => Diagnostic[] | Promise<Diagnostic[]>;
 export declare class CodeMirror6 {
     #private;
     get textarea(): HTMLTextAreaElement;
-    get view(): EditorView;
+    get view(): EditorView | undefined;
     get lang(): string;
     get visible(): boolean;
     /**
@@ -22,7 +22,12 @@ export declare class CodeMirror6 {
      * @param lang 语言
      * @param config 语言设置
      */
-    constructor(textarea: HTMLTextAreaElement, lang?: string, config?: unknown);
+    constructor(textarea: HTMLTextAreaElement, lang?: string, config?: unknown, init?: boolean);
+    /**
+     * 初始化编辑器
+     * @param config 语言设置
+     */
+    initialize(config?: unknown): void;
     /**
      * 设置语言
      * @param lang 语言
@@ -70,7 +75,7 @@ export declare class CodeMirror6 {
      * 设置翻译信息
      * @param messages 翻译信息
      */
-    localize(messages: Record<string, string>): void;
+    localize(messages?: Record<string, string>): void;
     /**
      * 获取语法树节点
      * @param position 位置
@@ -78,9 +83,9 @@ export declare class CodeMirror6 {
     getNodeAt(position: number): SyntaxNode | undefined;
     /**
      * 滚动至指定位置
-     * @param r 位置
+     * @param position 位置
      */
-    scrollTo(r?: number | {
+    scrollTo(position?: number | {
         anchor: number;
         head: number;
     }): void;