Skip to content

Commit 2907d31

Browse files
committed
docs: update README
1 parent e0e1ebe commit 2907d31

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@
3030
</details>
3131

3232
## NOTE!!
33-
`vue-modern-cropper` uses `cropperjs@next` (v2), which is not yet stable release, you can check it's documentation [HERE](https://fengyuanchen.github.io/cropperjs/v2/api/)
33+
`vue-modern-cropper` uses `cropperjs` (v2), you can check it's documentation [HERE](https://fengyuanchen.github.io/cropperjs/)
3434

35-
As it current state, `cropperjs` is not SSR-friendly, though even if it's SSR-able, I think it would be better to render it client-only to avoid overhead on the server, so remember it wrap/mark the component as `ClientOnly` if your project have SSR-enabled.
35+
At its current state, `cropperjs` is not SSR-friendly, though, even if it's SSR-able, I think it would be better to render it client-only to avoid overhead on the server, so remember to wrap/mark the component as `ClientOnly` if your project have SSR-enabled.
3636

3737
Feel free to submit PRs to add helper functions 😘.
3838

@@ -57,7 +57,7 @@ import { ModernCropper } from 'vue-modern-cropper'
5757
const cropper = ref<InstanceType<typeof ModernCropper>>()
5858

5959
onMounted(async () => {
60-
// remember to await nextTick if you use Nuxt (Nuxt client component caveat)
60+
// remember to await nextTick if you use Nuxt (Nuxt client-component caveat)
6161
await nextTick()
6262

6363
// Use onCropperMounted to execute hooks as soon as the cropper APIs is available
@@ -69,7 +69,8 @@ onMounted(async () => {
6969
if (cropper.value.cropperMounted)
7070
cropper.value.cropper
7171
})
72-
...
72+
73+
... // Somewhere in the <template>:
7374
<ModernCropper
7475
ref="cropper"
7576
class="w-80 h-40"

0 commit comments

Comments
 (0)