1.0.2 • Published 6 years ago

xkutils v1.0.2

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

xkutils

Build Status LICENSE MIT

前端业务代码工具库

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

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

安装使用

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

浏览器:

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

npm:

$ npm install --save-dev xkutils

webpack、RequireJS、SeaJS等

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

推荐使用方法

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

// 只引入部分方法('xkutils/<方法名>')
const getOS = require('xkutils/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设置滚动条距顶部的距离

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}的剩余时间

Url

parseQueryStringurl参数转对象

stringfyQueryString对象序列化

Event

addEvent为对象添加事件监听事件

removeEvent为对象取消事件监听