common-utils-kit 1.1.4 → 1.1.18

package/.editorconfig

@@ -0,0 +1,7 @@
+[*.{js,jsx,ts,tsx,vue}]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 400

package/.eslintrc.js

@@ -0,0 +1,42 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+  },
+  extends: ['eslint:recommended', 'plugin:vue/recommended'],
+  parserOptions: {
+    parser: "@babel/eslint-parser",
+    requireConfigFile: false
+  },
+  rules: {
+    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    'import/prefer-default-export': 'off',
+    'no-param-reassign': 'off',
+    'vue/no-template-shadow': 'off',
+    'global-require': 0,
+    'linebreak-style': ['off'],
+    'vue/max-attributes-per-line': 'off',
+    'max-len': ['error', { code: 400, ignoreUrls: true, ignorePattern: '^\\s*xlink:href="*?' }],
+    'no-bitwise': 'off',
+    'guard-for-in': 'off',
+    'no-restricted-syntax': 'off',
+    'prefer-destructuring': 'off',
+    'no-underscore-dangle': 'off',
+    'new-cap': 'off',
+    'no-plusplus': 'off',
+    'vue/multi-word-component-names':'off',
+    'vue/first-attribute-linebreak':'off',
+    'vue/component-definition-name-casing':'off',
+    'vue/attributes-order':'off'
+  },
+  overrides: [
+    {
+      files: ['**/__tests__/*.{j,t}s?(x)', '**/tests/unit/**/*.spec.{j,t}s?(x)'],
+      env: {
+        mocha: true,
+      },
+    },
+  ],
+  ignorePatterns: ['src/assets/*'],
+};

package/.vscode/extensions.json

@@ -0,0 +1,14 @@
+{
+  "recommendations": [
+    "vue.volar",
+    "vue.vscode-typescript-vue-plugin",
+    "hollowtree.vue-snippets",
+    "dbaeumer.vscode-eslint",
+    "stylelint.vscode-stylelint",
+    "esbenp.prettier-vscode",
+    "editorconfig.editorconfig",
+    "streetsidesoftware.code-spell-checker",
+    "syler.sass-indented",
+    "mikestead.dotenv"
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "files.exclude": {
+    // "**/lib": true,
+    // "**/public": true
+  }
+}

package/README.md

@@ -1,34 +1,116 @@
-
-## Common Utils Kit
-
+# Vue2 Utils Kit
 `common-utils-kit`是一个包含常用函数的npm包，提供了一系列验证、防抖节流、数据格式化等功能
-
-## 使用
+## 安装
+```
+npm install common-utils-kit
 ```
-# 安装
-npm i common-utils-kit
 
-# 使用方式一（局部引入）
+### 全局引入
+新建 vue.prototype.js 文件
+```
+import Vue from 'vue';
+import commonUtilsKit from 'common-utils-kit';
+Vue.prototype.$files = commonUtilsKit.files;
+Vue.prototype.$format = commonUtilsKit.format;
+Vue.prototype.$test = commonUtilsKit.test;
+Vue.prototype.$tool = commonUtilsKit.tool;
+Vue.use(commonUtilsKit.directive); // 注册自定义指令
+```
+在main文件中引入vue.prototype.js
+```
+import './vue.prototype.js'; // 引入 vue.prototype.js
+```
+### 局部引入
+```
 import commonUtilsKit from "common-utils-kit";
 例：验证是否为数字 commonUtilsKit.test.number(1)
+```
+#### 使用方式
+```
+this.$test.email("200")  //false
+```
 
-# 使用方式二（全局引入）
-import commonUtilsKit from "common-utils-kit";
-Vue.prototype.$test = commonUtilsKit.test;
-例：验证是否为数字 this.$test.number(1)
-```
-### directives(指令)
- 1. debounce(按钮或输入框防抖)
- 2. inputDebounce(输入框防抖)
- 3. btnDebounce(按钮防抖)
- 4. btnThrottle(按钮节流)
- 5. relativeTime(相对时间)
- 6. replace(输入框字符串替换)
- 7. elDragDialog(拖拽dialog)
-### files(文件)
+# 使用文档
+
+## 指令列表(directives)
+
+### 1. `v-debounce`
+**描述**: 按钮或输入框防抖。
+```html
+<el-input v-model="aa" v-debounce="[reset, 'input', 1000]" placeholder="输入框数组防抖" />
+<el-button v-debounce="[reset, 'click', 1000]">刷新</el-button>
+```
+**参数说明**:
+- `v-debounce` - 指令接受一个数组，包含以下参数。
+- **方法**： 要执行的函数（如 `reset`）。
+- **事件类型**：要监听的事件类型（如 `'click'`）。
+- **延迟时间**：防抖延迟的时间，以毫秒为单位（如 `1000`）。
+
+### 2. `v-input-debounce`
+**描述**: 输入框防抖。
+```html
+<el-input v-input-debounce:1000="reset" placeholder="输入框防抖" />
+```
+**参数说明**:
+- `v-input-debounce` - 指令接受以下参数：
+- **延迟时间**：以毫秒为单位的防抖延迟时间（如 `1000`），默认为 500 毫秒。
+- **方法**：要执行的函数（如 `reset`）。
+
+### 3. `v-btn-debounce`
+**描述**: 按钮防抖。
+```html
+<el-button v-btn-debounce="500">防抖按钮</el-button>
+```
+**参数说明**:
+- `v-btn-debounce` - 指令接受以下参数：
+- **延迟时间**：以毫秒为单位的防抖延迟时间（如 `500`），默认为 1000 毫秒。
+
+### 4. `v-btn-throttle`
+**描述**: 按钮节流。
+```html
+<el-button v-btn-throttle="500">节流按钮</el-button>
+```
+**参数说明**:
+- `v-btn-throttle` - 指令接受以下参数：
+- **间隔时间**：以毫秒为单位的防抖延迟时间（如 `500`），默认为 1000 毫秒。
+
+### 5. `v-relative-time`
+
+**描述**: 时间转换，展示距离当前时间的相对时间。（刚刚，xx分钟前，xx小时前，xx天前，年/月/日）
+```html
+<div v-relative-time="1699795200000"></div>
+```
+**参数说明**:
+- `v-relative-time` - 指令接受以下参数：
+- **过去时间戳**：过去的时间戳（如 `1699795200000`）
+
+### 6. `v-replace`
+**描述**: 限制输入框的输入内容。
+```html
+<el-input v-replace:price="inputValue" />
+```
+**参数说明**:
+- `v-relative-time` - 指令接受以下参数：
+- **限制类型**：允许两位小数的金额`price`（如 price）
+- **限制类型**仅允许正数`plusPrice`（如 price）。
+- **限制类型**仅允许正整数`num`（如 price）。
+- **限制类型**仅允许自然数`natural`（如 price）。
+- **输入内容**限制输入的内容（如 inputValue）
+
+
+### 7. `v-el-drag-dialog`
+**描述**: 可拖拽的对话框（仅用于element-ui）。
+```html
+<el-dialog v-el-drag-dialog>
+  <div class="el-dialog__header">拖拽我</div>
+  <div>对话框内容</div>
+</el-dialog>
+```
+
+## 文件插件(files)
  1. downloadBase64File(base64文件下载)
  2. downloadFiles(文件http地址下载)
-### format(格式化数据)
+## 格式化数据(format)
  1. unrepeated(数组对象去重)
  2. treeToFlat(树形结构拍平为一维数组)
  3. flatToTree(一维数组递归成为树形结构)
@@ -37,7 +119,7 @@ Vue.prototype.$test = commonUtilsKit.test;
  6. dateDiff(计算日期差值(单位：天))
  7. getNowDate(获取当前日期)
  8. setFormColumnsData(设置自定义表单列数据)
-### test(验证)
+## 数据验证(test)
  1. hasValue(是否有值,可验证指定类型)
  2. valueType(返回数据类型)
  3. emai(是否为邮箱)
@@ -49,7 +131,12 @@ Vue.prototype.$test = commonUtilsKit.test;
  9. letter(是否为字母)
  10. landline(是否为座机)
  11. code(是否为6位数短信验证码)
-### tool(工具函数)
+## 通用工具(tool)
  1. debounce(防抖)
  2. throttle(节流)
  3. sleep(睡眠阻塞延时)
+## 组件使用
+### 文件预览（preview）
+需要安装 npm i docx-preview --save 预览docx
+需要安装 npm i axios --save 预览docx
+

package/lib/demo.html

@@ -0,0 +1 @@
+<!doctype html><meta charset="utf-8"><title>utils-kit demo</title><script src="./utils-kit.umd.js"></script><script>console.log(utils-kit)</script>