npm.io
2.0.0 • Published 7 years ago

common-tools-box

Licence
ISC
Version
2.0.0
Deps
0
Size
81 kB
Vulns
0
Weekly
0
Stars
1

前端业务代码工具库

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

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

安装使用

  1. 直接下载min目录下的toolsbox.min.js使用,支持UMD通用模块规范
  2. 使用npm安装

浏览器:

  <script src="toolsbox.min.js"></script>
  <script>
      var OS = toolsbox.getOS()
  </script>
npm:
$ npm install --save-dev common-tools-box

webpack、RequireJS、SeaJS等

// 完整引入
const toolsbox = require('common-tools-box')
const OS = toolsbox.getOS()

推荐使用方法

你真的不需要完整引入所有函数,所以只引入需要使用的方法即可。

const getOS = require('common-tools-box')
const OS = getOS()

当然,你的开发环境有 babel编译 ES6语法的话,也可以这样使用:

import getOS from 'common-tools-box/getOS'
// 或
import { getOS } from "common-tools-box";

API文档

Array
  arrayEqual  判断两个数组是否相等
  shuffle  洗牌函数(打乱数组)
Store
  saveToLocal  本地(localStorage)存储数据
  loadFromLocal  读取localStorage数据
Class
  addClass  为元素添加class
  hasClass  判断元素是否有某个class
  removeClass  为元素移除class
  getByClass  找到父元素下所有含有对应class的项并以数组形式返回
Css
  css  获取或设置行间样式
  getStyle  获取非行间样式
Event
  addEvent  封装事件绑定,实现一种事件绑定多个事件处理函数
  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  将阿拉伯数字翻译成中文的大写数字
String
  changeCase  字母大小写转换
  checkPwd  检测密码强度
  trim  去除空格
Support
  isSupportWebP  判断浏览器是否支持webP格式图片
Time
  formatDate  日期格式转化
  formatPassTime  格式化${startTime}距现在的已过时间
  formatRemainTime  格式化现在距${endTime}的剩余时间
  isLeapYear  判断是否为闰年
  isSameDay  判断是否为同一天
Url
  parseQueryString  url参数转对象
  stringfyQueryString  对象序列化

Keywords