Skip to content

Commit 16029f7

Browse files
committed
upgrade v2 version code
1 parent 8bccf91 commit 16029f7

File tree

1 file changed

+141
-0
lines changed

1 file changed

+141
-0
lines changed

README.md

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# Go Captcha Vue Package
2+
3+
```shell
4+
yarn add go-captcha-vue
5+
# or
6+
npm install go-captcha-vue
7+
# or
8+
pnpm install go-captcha-vue
9+
```
10+
11+
## Use Go Captcha
12+
```vue
13+
14+
import "go-captcha-vue/dist/style.css"
15+
import GoCaptcha from "go-captcha-vue"
16+
17+
Vue.use(GoCaptcha)
18+
```
19+
20+
21+
## 🖖 Click Mode Captcha
22+
```vue
23+
<gocaptcha-click
24+
:config="{}"
25+
:data="{}"
26+
:events="{}"
27+
/>
28+
```
29+
30+
### params
31+
```ts
32+
// config = {}
33+
interface Config {
34+
width?: number;
35+
height?: number;
36+
thumbWidth?: number;
37+
thumbHeight?: number;
38+
verticalPadding?: number;
39+
horizontalPadding?: number;
40+
showTheme?: boolean;
41+
}
42+
43+
// data = {}
44+
interface Data {
45+
image: string;
46+
thumb: string;
47+
}
48+
49+
// events = {}
50+
interface Events {
51+
click?: (x: number, y: number) => void;
52+
refresh?: () => void;
53+
close?: () => void;
54+
confirm?: (dots: Array<CaptchaDot>) => boolean;
55+
}
56+
```
57+
58+
## 🖖 Slide Mode Captcha
59+
```vue
60+
<gocaptcha-slide
61+
:config="{}"
62+
:data="{}"
63+
:events="{}"
64+
/>
65+
66+
<gocaptcha-slide-region
67+
:config="{}"
68+
:data="{}"
69+
:events="{}"
70+
/>
71+
```
72+
### params
73+
```ts
74+
// config = {}
75+
interface Config {
76+
width?: number;
77+
height?: number;
78+
thumbWidth?: number;
79+
thumbHeight?: number;
80+
verticalPadding?: number;
81+
horizontalPadding?: number;
82+
showTheme?: boolean;
83+
}
84+
85+
// data = {}
86+
interface Data {
87+
thumbX: number;
88+
thumbY: number;
89+
thumbWidth: number;
90+
thumbHeight: number;
91+
image: string;
92+
thumb: string;
93+
}
94+
95+
// events = {}
96+
interface Events {
97+
move?: (x: number, y: number) => void;
98+
refresh?: () => void;
99+
close?: () => void;
100+
confirm?: (point: CaptchaPoint) => boolean;
101+
}
102+
```
103+
104+
105+
## 🖖 Rotate Mode Captcha
106+
```vue
107+
<gocaptcha-rotate
108+
:config="{}"
109+
:data="{}"
110+
:events="{}"
111+
/>
112+
```
113+
114+
### params
115+
```ts
116+
// config = {}
117+
interface Config {
118+
width?: number;
119+
height?: number;
120+
thumbWidth?: number;
121+
thumbHeight?: number;
122+
verticalPadding?: number;
123+
horizontalPadding?: number;
124+
showTheme?: boolean;
125+
}
126+
127+
// data = {}
128+
interface Data {
129+
angle: number;
130+
image: string;
131+
thumb: string;
132+
}
133+
134+
// events = {}
135+
interface Events {
136+
rotate?: (angle: number) => void;
137+
refresh?: () => void;
138+
close?: () => void;
139+
confirm?: (angle: number) => boolean;
140+
}
141+
```

0 commit comments

Comments
 (0)