feat: default config

Author: wenlng

.gitattributes

@@ -0,0 +1,2 @@
+*.ts linguist-language=typescript
+*.vue linguist-language=vue

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Awen <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,5 +1,6 @@
 # Go Captcha Vue Package
 
+## Install
 ## 
 ```shell
 # Greater than or equal to vue2.7.14 and less than vue3.0
@@ -42,31 +43,33 @@ Vue.use(GoCaptcha)
 />
 ```
 
-### params
+### Parameter Reference
 ```ts
 // config = {}
-interface Config {
+interface ClickConfig {
   width?: number;
   height?: number;
   thumbWidth?: number;
   thumbHeight?: number;
   verticalPadding?: number;
   horizontalPadding?: number;
   showTheme?: boolean;
+  title?: string;
+  buttonText?: string;
 }
 
 // data = {}
-interface Data {
+interface ClickData {
   image: string;
   thumb: string;
 }
 
 // events = {}
-interface Events {
+interface ClickEvents {
   click?: (x: number, y: number) => void;
   refresh?: () => void;
   close?: () => void;
-  confirm?: (dots: Array<CaptchaDot>) => boolean;
+  confirm?: (dots: Array<ClickDot>) => boolean;
 }
 ```
 
@@ -84,21 +87,22 @@ interface Events {
   :events="{}"
 />
 ```
-### params
+### Parameter Reference
 ```ts
 // config = {}
-interface Config {
+interface SlideConfig {
   width?: number;
   height?: number;
   thumbWidth?: number;
   thumbHeight?: number;
   verticalPadding?: number;
   horizontalPadding?: number;
   showTheme?: boolean;
+  title?: string;
 }
 
 // data = {}
-interface Data {
+interface SlideData {
   thumbX: number;
   thumbY: number;
   thumbWidth: number;
@@ -108,14 +112,44 @@ interface Data {
 }
 
 // events = {}
-interface Events {
+interface SlideEvents {
   move?: (x: number, y: number) => void;
   refresh?: () => void;
   close?: () => void;
-  confirm?: (point: CaptchaPoint) => boolean;
+  confirm?: (point: SlidePoint) => boolean;
 }
 ```
+```ts
+// config = {}
+interface SlideRegionConfig {
+  width?: number;
+  height?: number;
+  thumbWidth?: number;
+  thumbHeight?: number;
+  verticalPadding?: number;
+  horizontalPadding?: number;
+  showTheme?: boolean;
+  title?: string;
+}
 
+// data = {}
+interface SlideRegionData {
+  thumbX: number;
+  thumbY: number;
+  thumbWidth: number;
+  thumbHeight: number;
+  image: string;
+  thumb: string;
+}
+
+// events = {}
+interface SlideRegionEvents {
+  move?: (x: number, y: number) => void;
+  refresh?: () => void;
+  close?: () => void;
+  confirm?: (point: SlideRegionPoint) => boolean;
+}
+```
 
 ## 🖖 Rotate Mode Captcha
 ```vue
@@ -126,31 +160,57 @@ interface Events {
 />
 ```
 
-### params
+### Parameter Reference
 ```ts
 // config = {}
-interface Config {
+interface RotateConfig {
   width?: number;
   height?: number;
   thumbWidth?: number;
   thumbHeight?: number;
   verticalPadding?: number;
   horizontalPadding?: number;
   showTheme?: boolean;
+  title?: string;
 }
 
 // data = {}
-interface Data {
+interface RotateData {
   angle: number;
   image: string;
   thumb: string;
 }
 
 // events = {}
-interface Events {
+interface RotateEvents {
   rotate?: (angle: number) => void;
   refresh?: () => void;
   close?: () => void;
   confirm?: (angle: number) => boolean;
 }
-```
+```
+
+
+## Button
+```vue
+<gocaptcha-button />
+```
+
+### params
+```ts
+interface _ {
+  config?: ButtonConfig;
+  clickEvent?: () => void;
+  disabled?: boolean;
+  type?: "default" | "warn" | "error" | "success";
+  title?: string;
+}
+
+export interface ButtonConfig {
+  width?: number;
+  height?: number;
+  verticalPadding?: number;
+  horizontalPadding?: number;
+}
+
+```

example/App.vue

@@ -4,6 +4,8 @@
   "private": false,
   "type": "module",
   "license": "MIT",
+  "email": "[email protected]",
+  "author": "Awen <[email protected]>",
   "description": "This is the vue package for go-captcha",
   "keywords": [
     "go-captcha-vue",
@@ -24,6 +26,7 @@
     "type": "git",
     "url": "git+https://github.com/wenlng/go-captcha-vue.git"
   },
+  "homepage": "https://github.com/wenlng/go-captcha-vue",
   "main": "dist/go-captcha-vue.umd.js",
   "module": "dist/go-captcha-vue.es.js",
   "types": "./dist/index.d.ts",
@@ -40,13 +43,17 @@
     "preview": "vite preview --port 5050",
     "type-check": "vue-tsc --noEmit -p tsconfig.json"
   },
+  "peerDependencies": {
+    "vue": ">=3"
+  },
   "dependencies": {
     "vue": "^3.0.1"
   },
   "devDependencies": {
     "@types/node": "^16.11.10",
     "@vitejs/plugin-vue": "4.4.0",
     "@vitejs/plugin-vue-jsx": "^3.1.0",
+    "autoprefixer": "^10.4.19",
     "fast-glob": "^3.3.2",
     "less": "^4.2.0",
     "less-loader": "^12.2.0",

package.json

@@ -1,6 +1,6 @@
 <template>
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="xMidYMid" width="84" height="84" v-bind="$attrs" @click="emitClickEvent">
-    <circle cx="50" cy="36.8101" r="10" fill="#3e7cff">
+    <circle cx="50" cy="36.8101" r="10">
       <animate attributeName="cy" dur="1s" repeatCount="indefinite" calcMode="spline" keySplines="0.45 0 0.9 0.55;0 0.45 0.55 0.9" keyTimes="0;0.5;1" values="23;77;23"></animate>
     </circle>
   </svg>

packages/assets/icons/loading-icon.vue

@@ -1,3 +1,9 @@
+/**
+ * @Author Awen
+ * @Date 2024/06/01
+ * @Email [email protected]
+ **/
+
 import capt from './index.vue'
 
 // @ts-ignore