Skip to content

Commit 9b89466

Browse files
committed
docs: update readme docs
1 parent 6183eae commit 9b89466

3 files changed

Lines changed: 7 additions & 8 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ package-lock.json
77
.cache
88
.parcel-cache
99
.vscode
10-
example
10+
example
11+
*.tgz

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ function App() {
6666
onChange={(value) => {
6767
console.log(value);
6868
}}
69-
editorInstanceRef={(ins) => (editorRef.current = ins)}
69+
editorDidMount={(ins) => (editorRef.current = ins)}
7070
/>
7171
);
7272
}
@@ -88,7 +88,7 @@ function App() {
8888
onChange={(value) => {
8989
console.log(value);
9090
}}
91-
diffEditorInstanceRef={(ins) => (editorRef.current = ins)}
91+
editorDidMount={(ins) => (editorRef.current = ins)}
9292
/>
9393
);
9494
}
@@ -124,7 +124,6 @@ common properties can be used on `MonacoEditor` and `MonacoDiffEditor`.
124124
- `value` value of model in modifiedEditor.
125125
- `original` value of model in originalEditor.
126126
- `options` options for monaco diff editor, refer to monaco interface [IStandaloneDiffEditorConstructionOptions](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IStandaloneDiffEditorConstructionOptions.html).
127-
- `readOnly` set modified editor readonly.
128127
- **[deprecated]** `diffEditorInstanceRef` get diff editor instance.
129128
- `editorWillMount` called immediately before the editor is mounted (similar to componentWillMount of React).
130129
- `editorDidMount` called immediately after the editor is mounted (similar to componentDidMount of React).
@@ -134,7 +133,7 @@ common properties can be used on `MonacoEditor` and `MonacoDiffEditor`.
134133

135134
## Support more sql languages
136135

137-
Please See [monaco-sql-languages](https://github.com/DTStack/monaco-sql-languages).
136+
Please see [monaco-sql-languages](https://github.com/DTStack/monaco-sql-languages).
138137

139138
`monaco-sql-languages` provides **highlighting**, **error prompts** and **auto-completion** functions for many kinds of SQL Languages for BigData domain. It supports on-demand import and is easy to integrate.
140139

README.zh-CN.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ function App() {
6666
onChange={(value) => {
6767
console.log(value);
6868
}}
69-
editorInstanceRef={(ins) => (editorRef.current = ins)}
69+
editorDidMount={(ins) => (editorRef.current = ins)}
7070
/>
7171
);
7272
}
@@ -88,7 +88,7 @@ function App() {
8888
onChange={(value) => {
8989
console.log(value);
9090
}}
91-
diffEditorInstanceRef={(ins) => (editorRef.current = ins)}
91+
editorDidMount={(ins) => (editorRef.current = ins)}
9292
/>
9393
);
9494
}
@@ -124,7 +124,6 @@ function App() {
124124
- `value` modifiedEditor(右边的编辑器) 的值。
125125
- `original` originalEditor(左边的编辑器) 的值。
126126
- `options` Monaco DiffEditor 的选项, 关联 monaco 接口 [IStandaloneDiffEditorConstructionOptions](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IStandaloneDiffEditorConstructionOptions.html).
127-
- `readOnly` modifiedEditor(右边的编辑器)是否为只读模式。
128127
- **[deprecated]** `diffEditorInstanceRef` 获取 `MonacoDiffEditor` 内部的 diffEditor 实例。
129128
- `editorWillMount` 在编辑器即将挂载时调用(类似于 React 的 componentWillMount)。
130129
- `editorDidMount` 当编辑器挂载完成时调用 (类似于 React 的 componentDidMount)。

0 commit comments

Comments
 (0)