vue-tools-box

Vue 前端业务代码工具库

• 封装了若干组件
• 封装了若干工具函数
• 封装了公共样式 CSS

业务开发过程中，会经常用到日期格式化、url参数转对象、浏览器类型判断、节流函数等常用函数，flex 等样式以及一些弹窗、提示组件等，为避免不同项目多次复制粘贴的麻烦，这里统一封装，并发布到 npm，以提高开发效率。如果你也有常用的代码，欢迎为本项目提交 pr。

目的：高效率完成前端业务代码

👤 作者

Harvey Liu

📮 邮箱

[email protected]

JavaScript utility and helper functions

安装 Installation:

npm

npm install --save vue-tools-box

yarn

yarn add vue-tools-box

使用 Usage:

import vueToolsBox from 'vue-tools-box'
import 'vue-tools-box/dist/index.css'
app.use(vueToolsBox)

Nuxt3 中使用

请参考node_modules/vue-tools-box/dist/nuxt.js/目录下的配置

// vue-tools-box.client.ts
import { defineNuxtPlugin } from '#app'
import VueToolsBox from 'vue-tools-box'
import 'vue-tools-box/dist/index.css'
export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.use(VueToolsBox, {})
})

// nuxt.config.ts
export default defineNuxtConfig({
  css: ['vue-tools-box/dist/styles/index.scss'],
})

样式使用

全局引入使用

在vue.config.js文件中配置后，即可在全局文件使用

 css: {
    sourceMap: false,
    loaderOptions: {
      scss: {
        prependData: '@import "vue-tools-box/dist/styles/index.scss";'
      }
    }

组件&插件

需要在'main.js`或者页面中引用 css 文件

import 'vue-tools-box/index.css'

组件使用

| 序号 | 名称 | 描述 | 用法 | | ---- | ------ | ---- | ----------------------------------- | | 1 | xtable(测试demo) | 表格 | <vue3-xmw-table></vue3-xmw-table> |

插件使用

| 序号 | 名称 | 描述 | 用法 | | ---- | ----- | -------------- | ------------------------------------------------------------ | | 1 | toast | 右上角消息提示 | toast({ title: '123', content: 'hello', type: 'warning' }) |

函数列表

列表

Array

  arrayEqual  判断两个数组是否相等    vue2：this.$toolbox.array.arrayEqual()

  shuffle  洗牌函数（打乱数组） example

Store

  saveToLocal  本地（localStorage）存储数据

  loadFromLocal  读取 localStorage 数据

Class

  addClass  为元素添加 class

  hasClass  判断元素是否有某个 class

  removeClass  为元素移除 class

  getByClass  找到父元素下所有含有对应 class 的项并以数组形式返回

Css

  css  获取或设置行间样式

  getStyle  获取非行间样式

Event

  addEvent  封装事件绑定，实现一种事件绑定多个事件处理函数

Cookie

  getCookie  根据 name 读取 Cookie

  removeCookie  根据 name 删除 Cookie

  setCookie  添加 Cookie

Device

  getExplore  获取浏览器类型和版本号

  getOS  获取操作系统类型

Dom

  getScrollTop  获取滚动条距顶部的距离

  offset  获取一个元素的距离文档(document)的位置，类似 jQ 中的 offset()

  scrollTo  在${duration}时间内，滚动条平滑滚动到${to}指定位置

  setScrollTop  设置滚动条距顶部的距离

  windowResize  H5 软键盘缩回、弹起回调

Function

  debounce  函数防抖

  throttle  函数节流

Keycode

  getKeyName  根据 keycode 获得键名

Object

  deepClone  深拷贝，支持常见类型

  isEmptyObject  判断 Object 是否为空

Random

  randomColor   随机生成颜色

  randomNum  生成指定范围随机数

Regexp

  isEmail  判断是否为邮箱地址

  isIdCard  判断是否为身份证号

  isPhoneNum  判断是否为手机号

  isUrl  判断是否为 URL 地址

Number

  digitUppercase  现金额转大写

  numToChinese  将阿拉伯数字翻译成中文的大写数字

  [keepOneDecimalFull][keepOneDecimalFull]  保留一位小数显示

String

  changeCase  字母大小写转换

  checkPwd  检测密码强度

  trim  去除空格

Support

  isSupportWebP  判断浏览器是否支持 webP 格式图片

Time

  formatDate  日期格式转化

  formatPassTime  格式化${startTime}距现在的已过时间

  formatRemainTime  格式化现在距${endTime}的剩余时间

  isLeapYear  判断是否为闰年

  isSameDay  判断是否为同一天

Url

  parseQueryString  url 参数转对象

  stringfyQueryString  对象序列化