go-captcha-vue 2.0.4 → 2.0.5

package/README.md

@@ -1,27 +1,38 @@
-# Go Captcha Vue Package
+<div align="center">
+<img width="120" style="padding-top: 50px; margin: 0;" src="http://47.104.180.148/go-captcha/gocaptcha_logo.svg?v=1"/>
+<h1 style="margin: 0; padding: 0">Go Captcha</h1>
+<p>Behavior Captcha For Vue</p>
 
-<p> ⭐️ If it helps you, please give a star.</p>
-<img src="http://47.104.180.148/go-captcha/go-captcha-v2.jpg" alt="Poster">
+</div>
 
+<br/>
+
+> English | [中文](README_zh.md)
 
 <br/>
 
+<p> ⭐️ If it helps you, please give a star.</p>
+
+<img src="http://47.104.180.148/go-captcha/go-captcha-v2.jpg" alt="Poster">
+
+
 | Vue Version            | Go Captcha Version |
 |:-----------------------|:------------------:|
 | vue >= 2.7.14 && < 3.0 | go-captcha-vue@^1  |
 | vue >= 3.0             | go-captcha-vue@^2  |
 
 ## Install
+Greater than or equal to vue2.7.14 and less than vue3.0
 ```shell
-# Greater than or equal to vue2.7.14 and less than vue3.0
 yarn add go-captcha-vue@^1
 # or
 npm install go-captcha-vue@^1
 # or
 pnpm install go-captcha-vue@^1
+```
 
-############################################
-# Greater than vue3.0
+Greater than vue3.0
+```shell
 yarn add go-captcha-vue@^2
 # or
 npm install go-captcha-vue@^2
@@ -29,27 +40,44 @@ npm install go-captcha-vue@^2
 pnpm install go-captcha-vue@^2
 ```
 
-Use Go Captcha
+## Use Go Captcha
 ```ts
 import "go-captcha-vue/dist/style.css"
 import GoCaptcha from "go-captcha-vue"
 
 Vue.use(GoCaptcha)
+
+// OR
+import {Click, Rotate, Slide, SlideRegion, Button} from "go-captcha-vue";
+Vue.component('gocaptcha-click', Click)
+Vue.component('gocaptcha-rotate', Rotate)
+Vue.component('gocaptcha-slide', Slide)
+Vue.component('gocaptcha-slide-region', SlideRegion)
+Vue.component('gocaptcha-button', Button)
 ```
 
-## 🖖 Click Mode Captcha
+
+## Click Mode
 ```vue
 <gocaptcha-click
   :config="{}"
   :data="{}"
   :events="{}"
+  ref="domRef"
 />
+
+<script>
+  // call methods
+  const domRef = ref(null)
+  domRef.value.clear()
+  domRef.value.refresh()
+</script>
 ```
 
-### Parameter Reference
+
 ```ts
 // config = {}
-interface ClickConfig {
+interface Config {
   width?: number;
   height?: number;
   thumbWidth?: number;
@@ -64,43 +92,46 @@ interface ClickConfig {
 }
 
 // data = {}
-interface ClickData {
+interface Data {
   image: string;
   thumb: string;
 }
 
 // events = {}
-interface ClickEvents {
+interface Events {
   click?: (x: number, y: number) => void;
   refresh?: () => void;
   close?: () => void;
-  confirm?: (dots: Array<ClickDot>, reset:() => void) => void;
+  confirm?: (dots: Array<ClickDot>, reset:() => void) => boolean;
 }
 
-// component call method
-interface ClickExpose {
-  reset: Function,
-  clear: Function,
-  refresh: Function,
-  close: Function,
+// export component method
+interface ExportMethods {
+  reset: () => void,
+  clear: () => void,
+  refresh: () => void,
+  close: () => void,
 }
 ```
 
-## 🖖 Slide Mode Captcha
+## Slide Mode
 ```vue
 <gocaptcha-slide
   :config="{}"
   :data="{}"
   :events="{}"
+  ref="domRef"
 />
 
-<gocaptcha-slide-region
-  :config="{}"
-  :data="{}"
-  :events="{}"
-/>
+<script>
+// call methods
+const domRef = ref(null)
+domRef.value.clear()
+domRef.value.refresh()
+</script>
 ```
-### Parameter Reference
+
+
 ```ts
 // config = {}
 interface SlideConfig {
@@ -112,6 +143,7 @@ interface SlideConfig {
   horizontalPadding?: number;
   showTheme?: boolean;
   title?: string;
+  iconSize?: number;
   scope ?: boolean;
 }
 
@@ -130,17 +162,36 @@ interface SlideEvents {
   move?: (x: number, y: number) => void;
   refresh?: () => void;
   close?: () => void;
-  confirm?: (point: SlidePoint, reset:() => void) => void;
+  confirm?: (point: SlidePoint, reset:() => void) => boolean;
 }
 
-// component call method
-interface SlideExpose {
-  reset: Function,
-  clear: Function,
-  refresh: Function,
-  close: Function,
+// export component method
+interface ExportMethods {
+  reset: () => void,
+  clear: () => void,
+  refresh: () => void,
+  close: () => void,
 }
 ```
+
+## Drag-And-Drop Mode
+```vue
+<gocaptcha-slide-region
+  :config="{}"
+  :data="{}"
+  :events="{}"
+  ref="domRef"
+/>
+
+<script>
+// call methods
+const domRef = ref(null)
+domRef.value.clear()
+domRef.value.refresh()
+</script>
+```
+
+
 ```ts
 // config = {}
 interface SlideRegionConfig {
@@ -152,6 +203,7 @@ interface SlideRegionConfig {
   horizontalPadding?: number;
   showTheme?: boolean;
   title?: string;
+  iconSize?: number;
   scope ?: boolean;
 }
 
@@ -170,31 +222,39 @@ interface SlideRegionEvents {
   move?: (x: number, y: number) => void;
   refresh?: () => void;
   close?: () => void;
-  confirm?: (point: SlideRegionPoint, reset:() => void) => void;
+  confirm?: (point: SlideRegionPoint, reset:() => void) => boolean;
 }
 
-// component call method
-interface SlideRegionExpose {
-  reset: Function,
-  clear: Function,
-  refresh: Function,
-  close: Function,
+// export component method
+interface ExportMethods {
+  reset: () => void,
+  clear: () => void,
+  refresh: () => void,
+  close: () => void,
 }
 ```
 
-## 🖖 Rotate Mode Captcha
+## Rotation Mode
 ```vue
 <gocaptcha-rotate
   :config="{}"
   :data="{}"
   :events="{}"
+  ref="domRef"
 />
+
+<script>
+// call methods
+const domRef = ref(null)
+domRef.value.clear()
+domRef.value.refresh()
+</script>
 ```
 
-### Parameter Reference
+
 ```ts
 // config = {}
-interface RotateConfig {
+interface Config {
   width?: number;
   height?: number;
   thumbWidth?: number;
@@ -203,40 +263,42 @@ interface RotateConfig {
   horizontalPadding?: number;
   showTheme?: boolean;
   title?: string;
+  iconSize?: number;
   scope ?: boolean;
 }
 
 // data = {}
-interface RotateData {
+interface Data {
   angle: number;
   image: string;
   thumb: string;
 }
 
 // events = {}
-interface RotateEvents {
+interface Events {
   rotate?: (angle: number) => void;
   refresh?: () => void;
   close?: () => void;
-  confirm?: (angle: number, reset:() => void) => void;
+  confirm?: (angle: number, reset:() => void) => boolean;
 }
 
-// component call method
-interface RotateExpose {
-  reset: Function,
-  clear: Function,
-  refresh: Function,
-  close: Function,
+// export component method
+interface ExportMethods {
+  reset: () => void,
+  clear: () => void,
+  refresh: () => void,
+  close: () => void,
 }
 ```
 
 
+
 ## Button
 ```vue
 <gocaptcha-button @clickEvent="() => console.log('hello')"/>
 ```
 
-### params
+
 ```ts
 interface $Attr {
   config?: CaptchaConfig;
@@ -249,19 +311,10 @@ interface $Event {
   clickEvent?: ()=>void;     // event -> @clickEvent=""
 }
 
-export interface ButtonConfig {
+export interface CaptchaConfig {
   width?: number;
   height?: number;
   verticalPadding?: number;
   horizontalPadding?: number;
 }
-
 ```
-
-<br/>
-
-## 👍 Sponsor
-<div>
-<a href="http://gocaptcha.wencodes.com/sponsor/" target="_blank">http://gocaptcha.wencodes.com/sponsor/</a>
-</div>
-<br/>