Skip to content

Commit 665b28d

Browse files
committed
docs: update docs
1 parent c759a2f commit 665b28d

File tree

5 files changed

+94
-98
lines changed

5 files changed

+94
-98
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ yarn add codemirror-editor-vue3 codemirror@5.x
2424
```
2525

2626
```bash
27-
pnpm i codemirror-editor-vue3 codemirror@5.x -S
27+
pnpm i codemirror-editor-vue3 codemirror@^5.65.12 -S
2828
```
2929

3030
> If your project requires Typescript support, you will also need to install the '@types/codemirror' dependency.
3131
3232
```bash
33-
npm install @types/codemirror@5.60.5 -D
33+
npm install @types/codemirror -D
3434
```
3535

3636
## Register global component

docs/en/guide/getting-started.md

Lines changed: 43 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ npm install codemirror-editor-vue3 codemirror@5.x -S
2020
```
2121

2222
```bash [yarn]
23-
yarn add codemirror-editor-vue3 codemirror@5.x
23+
yarn add codemirror-editor-vue3 codemirror@^5.65.12
2424
```
2525

2626
```bash [pnpm]
27-
pnpm i codemirror-editor-vue3 codemirror@5.x -S
27+
pnpm i codemirror-editor-vue3 codemirror@^5.65.12 -S
2828
```
2929

3030
:::
@@ -36,15 +36,15 @@ If your project requires Typescript support, you will also need to install the t
3636
::: code-group
3737

3838
```bash [npm]
39-
npm install @types/codemirror@5.60.5 -D
39+
npm install @types/codemirror -D
4040
```
4141

4242
```bash [yarn]
43-
yarn add @types/codemirror@5.60.5
43+
yarn add @types/codemirror
4444
```
4545

4646
```bash [pnpm]
47-
pnpm i @types/codemirror@5.60.5 -D
47+
pnpm i @types/codemirror -D
4848
```
4949

5050
:::
@@ -106,9 +106,9 @@ Specific code is as follows:
106106
</Codemirror>
107107
</template>
108108
<script>
109-
import { ref, onMounted, onUnmounted } from 'vue'
110-
import 'codemirror/mode/javascript/javascript.js'
111-
import Codemirror from 'codemirror-editor-vue3'
109+
import { ref, onMounted, onUnmounted } from "vue";
110+
import "codemirror/mode/javascript/javascript.js";
111+
import Codemirror from "codemirror-editor-vue3";
112112
export default {
113113
components: { Codemirror },
114114
setup() {
@@ -118,55 +118,55 @@ for (; i < 9; i++) {
118118
console.log(i);
119119
// more statements
120120
}
121-
`)
121+
`
122+
);
122123
123-
const cmRef = ref()
124+
const cmRef = ref();
124125
const cmOptions = {
125-
mode: 'text/javascript'
126-
}
126+
mode: "text/javascript",
127+
};
127128
const onChange = (val, cm) => {
128-
console.log(val)
129-
console.log(cm.getValue())
130-
}
129+
console.log(val);
130+
console.log(cm.getValue());
131+
};
131132
132133
const onInput = (val) => {
133-
console.log(val)
134-
}
134+
console.log(val);
135+
};
135136
136137
const onReady = (cm) => {
137-
console.log(cm.focus())
138-
}
138+
console.log(cm.focus());
139+
};
139140
140141
onMounted(() => {
141142
setTimeout(() => {
142-
cmRef.value?.refresh()
143-
}, 1000)
143+
cmRef.value?.refresh();
144+
}, 1000);
144145
145146
setTimeout(() => {
146-
cmRef.value?.resize(300, 200)
147-
}, 2000)
147+
cmRef.value?.resize(300, 200);
148+
}, 2000);
148149
149150
setTimeout(() => {
150-
cmRef.value?.cminstance.isClean()
151-
}, 3000)
152-
})
151+
cmRef.value?.cminstance.isClean();
152+
}, 3000);
153+
});
153154
154155
onUnmounted(() => {
155-
cmRef.value?.destroy()
156-
})
156+
cmRef.value?.destroy();
157+
});
157158
158159
return {
159160
code,
160161
cmRef,
161162
cmOptions,
162163
onChange,
163164
onInput,
164-
onReady
165-
}
166-
}
167-
}
165+
onReady,
166+
};
167+
},
168+
};
168169
</script>
169-
170170
```
171171

172172
```vue [index.vue(ts setup)]
@@ -188,7 +188,7 @@ for (; i < 9; i++) {
188188
import { ref, onMounted, onUnmounted } from "vue";
189189
import "codemirror/mode/javascript/javascript.js";
190190
import Codemirror from "codemirror-editor-vue3";
191-
import type { CmComponentRef } from "codemirror-editor-vue3"
191+
import type { CmComponentRef } from "codemirror-editor-vue3";
192192
import type { Editor, EditorConfiguration } from "codemirror";
193193
194194
const code = ref(
@@ -197,8 +197,9 @@ for (; i < 9; i++) {
197197
console.log(i);
198198
// more statements
199199
}
200-
`);
201-
const cmRef = ref<CmComponentRef>()
200+
`
201+
);
202+
const cmRef = ref<CmComponentRef>();
202203
const cmOptions: EditorConfiguration = {
203204
mode: "text/javascript",
204205
};
@@ -218,29 +219,26 @@ const onReady = (cm: Editor) => {
218219
219220
onMounted(() => {
220221
setTimeout(() => {
221-
cmRef.value?.refresh()
222+
cmRef.value?.refresh();
222223
}, 1000);
223224
224225
setTimeout(() => {
225-
cmRef.value?.resize(300,200)
226+
cmRef.value?.resize(300, 200);
226227
}, 2000);
227228
228229
setTimeout(() => {
229-
cmRef.value?.cminstance.isClean()
230+
cmRef.value?.cminstance.isClean();
230231
}, 3000);
231-
})
232+
});
232233
233234
onUnmounted(() => {
234-
cmRef.value?.destroy()
235-
})
235+
cmRef.value?.destroy();
236+
});
236237
</script>
237-
238-
239238
```
240239

241240
:::
242241

243-
244242
<script >
245243
import {shallowRef} from "vue"
246244
export default {

docs/en/typescript/Support.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
::: code-group
99
```bash [npm]
10-
npm install @types/codemirror@5.x -D
10+
npm install @types/codemirror -D
1111
```
1212
```bash [yarn]
13-
yarn add @types/codemirror@5.x
13+
yarn add @types/codemirror
1414
```
1515
```bash [pnpm]
16-
pnpm i @types/codemirror@5.x -D
16+
pnpm i @types/codemirror -D
1717
```
1818
:::
1919

0 commit comments

Comments
 (0)