1.1.2 • Published 6 years ago

shareutils v1.1.2

Weekly downloads
4
License
MIT
Repository
github
Last release
6 years ago

shareutils

前端通用工具库

优点:提高前端业务代码开发效率,增强代码复用性

前端开发过程中,会经常用到判断浏览器类型格式化各种日期获取url参数queryString转对象防抖函数节流函数等常用函数,为避免不同项目多次复制粘贴的麻烦,这里统一封装,并发布到npm,以提高开发效率。欢迎为本项目提交pr。

安装使用

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

浏览器:

  <script src="shareutils.min.js"></script>
  <script>
      var OS = shareutils.getOS()
  </script>

npm:

$ npm install --save-dev shareutils

webpack、RequireJS、SeaJS等

// 完整引入
const shareutils = require('shareutils')
const OS = shareutils.getOS()

推荐使用方法

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

// 只引入部分方法('shareutils/modules/<方法名>')
const getOS = require('shareutils/modules/getOS')
const OS = getOS()

API文档

Array

arrayEqual判断两个数组是否相等

Class

addClass为元素添加class

hasClass判断元素是否有某个class

removeClass为元素移除class

Cookie

getCookie根据name读取Cookie

removeCookie根据name删除Cookie

setCookie添加Cookie

Device

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

getOS获取操作系统类型

Dom

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

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

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

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

windowResizeH5软键盘缩回、弹起回调

Function

debounce函数防抖

throttle函数节流

Keycode

getKeyName根据keycode获得键名

Object

deepClone深拷贝,支持常见类型

isEmptyObject判断Object是否为空

Random

randomColor 随机生成颜色

randomNum生成指定范围随机数

Regexp

isEmail判断是否为邮箱地址

isIdCard判断是否为身份证号

isPhoneNum判断是否为手机号

isUrl判断是否为URL地址

String

digitUppercase现金额转大写

Support

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

Time

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

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

isSameDay判断是否为同一天

Url

parseQueryStringurl参数转对象

stringfyQueryString对象序列化