项目介绍

该项目整理了前端比较常用的工具集,包括js工具和css工具;
当我们新建一个前端项目时,只需要引入这个npm包,就可以省去很多写工具的重复工作;

源码地址APIversioncollection

项目规范函数使用小驼峰方式命名对象使用大驼峰方式命名项目使用webpack构建,支持按需引入支持直接引入编译前的源文件:less文件、es6文件安装

$ npm install @jnlong/eutils

使用js

// js引用方法1 import eutils from 'eutils'; eutils.date.format('2018-9-6', '{y}/{m}/{d} {h}:{i}:{s}'); // js引用方法2 import {type, urlParse, date, log as ulog} from 'eutils'; date.format(new Date(), 'YYYY-MM-DD HH:mm:ss.SSS'); // 按需引入js源文件 import date as uDate from 'eutils/src/js/date'style

// 引入css @import 'eutils/dist/index.css'; // 引入less:webpack需要配置less解析 @import 'eutils/src/style/index.less'; @import 'eutils/src/style/index.less';用法

在 example/main.js中编写了每一个API的用法,可以打开文件查看。

example

可以运行样例查看example

git clone git@github.com:jnlong/eutils.gitcd eutilsnpm install --save-devnpm run dev用浏览器打开 http://localhost:8088/查看example,也可以同时打开浏览器的控制台查看console信息APItools

为了方便调用,tools目录的API生成在eutils根目录,调用方法:eutils.log(), eutils.toast(msg)

log调用方法:eutils.log(arg1, arg2, arg3, ...);参数:log(args),接受多个参数;打印日志,可以通过window.isDebug来全局控制是否打印的开关,实现只在测试环境打印日志;为了提高可读性,在打印时对一个参数设置了颜色
deepCopy

object深拷贝,使用深拷贝的目的是:避免复制后的对象的更改,传递给源对象;
调用方法:eutils.deepCopy(obj);

参数参数类型必填说明dataObject是需要执行深拷贝的object返回参数类型说明dataObject执行深拷贝后的对象checkLs判断所在浏览器是否支持localStorage;调用方法:eutils.checkLs();返回:Booleantoast

toast弹窗,调用后弹出一个toast;
调用方法:eutils.toast('我是一个toast');

versionCompare

调用方法:eutils.versionCompare(v1, v2);

参数参数类型必填说明v1String是版本号1v2String是版本号2返回参数类型说明resNumberv1=v2, 返回0;v1大于v2, 返回1;v1小于v2,返回-1;dateformat

日期格式化;
调用方法:etuils.date.format(new Date(), 'YYYY-MM-DD [at] HH:mm:ss');

参数参数类型必填说明dateDate是需要格式化的日期formatString是格式样式,例如'YYYY-MM-DD [at] HH:mm:ss'返回参数类型说明resString返回样例 '2018-10-15 at 08:06:20'calDuration

计算时间2比时间1,间隔的时长,同时支持之前和之后;如 1年前,3个月前,20天前,5分钟前,2秒前,5个月后,3小时后;
调用方法:eutils.date.calDuration(d1, d2) ;

参数参数类型必填说明d1Date是日期1d2Date是日期2返回参数类型说明resString返回时间2 比 时间1,间隔的时长,如 '3个月前'、'5小时后'等等add

(new Date(), unit, count) 对一个日期对象,加上某个单位的数量;比如给一个日期加3天:add(new Date(), 'd', 3)
调用方法:eutils.date.calDuration(d1, d2) ;

参数参数类型必填说明d1Date是日期1d2Date是日期2返回参数类型说明resString时间2 比 时间1,间隔的时长,如 '3个月前'、'5小时后'等等cookieget

获取cookie;
调用方法:eutils.cookie.get(name) ;

参数参数类型必填说明nameString是cookie的名称返回参数类型说明resStringcookie的valueset

添加cookie;
调用方法:eutils.cookie.set({name: '', value: '', days: 3, path: '/'}) ;

参数参数类型必填说明optJson是json格式,其中days表示失效时间(单位天)del

删除cookie;
调用方法:eutils.cookie.del(name) ;

参数参数类型必填说明nameString是cookie的名称urlparsesearch

调用方法:eutils.urlparse.search(name, url);

参数参数类型必填说明nameString是需要查找的query名称;urlString否query所在的url,默认是location.search;返回参数类型说明resStringname在url中对应的value,查找不到则返回空字符串('')add

在url上添加参数,并且返回新的url;
调用方法:eutils.urlparse.add(name, value, url);

参数参数类型必填说明nameString是query的名称;valueString是query的值;urlString否需要添加参数的url,默认是location.search;返回参数类型说明resString添加参数后的urlremove

在url上删除参数;
调用方法:eutils.urlparse.remove(name, url);

参数参数类型必填说明nameString是需要查找的query名称;urlString否query所在的url,默认是location.search;返回参数类型说明resString删除参数后的urlreplace

调用方法:eutils.urlparse.replace(name, newValue, url);

参数参数类型必填说明nameString是需要查找的query名称;newValueString是需要替换的value;urlString否query所在的url,默认是location.search;返回参数类型说明resString替换参数后的urljsonToQuery

将json转换成url格式;
调用方法:eutils.urlparse.jsonToQuery(obj);

参数参数类型必填说明objJSON是返回参数类型说明resString转换后的urlqueryToJson

将url转换成json格式
调用方法:eutils.urlparse.queryToJson(url);

参数参数类型必填说明urlString否默认是location.search;返回参数类型说明resJson转换后的json对象load

为了方便调用,load目录的API生成在eutils根目录

loadCss

动态加载外部css链接,并且通过id校验来避免重复添加;
调用方法:eutils.loadCss(href, id);

参数参数类型必填说明hrefString是css链接idString否不传参数,则不做重复添加的校验loadScript

动态加载script,并且通过id校验来避免重复添加;
调用方法:eutils.loadScript(src, cb, id);

参数参数类型必填说明srcString是script链接cbFuncton是资源下载成功的回调函数,如果不需要回调,可以传nullidString否不传参数,则不做重复添加的校验loadImg

(src, cb, id)

参数参数类型必填说明srcString是img链接cbFuncton是资源下载成功的回调函数,如果不需要回调,可以传nullidString否不传参数,则不做重复添加的校验type

为了方便调用,type目录的API生成在eutils根目录,调用方法如:eutils.isSupportWebP()

isSupportWebP

判断是否支持webp格式的图片
返回:Boolean

isString(obj)

判断obj是不是String类型
返回:Boolean

isNumber(obj)

判断obj是不是Numbe类型
返回:Boolean

isArray(obj)

判断obj是不是Arra类型
返回:Boolean

isFunction(obj)

判断obj是不是Function类型
返回:Boolean

isDate(obj)

判断obj是不是Date类型
返回:Boolean

checkType

类型判断:判断str是否是指定类型,返回Boolean;
调用方法:eutils.checkType(str, type);
正则校验的类型: IP、QQ、english、chinese、tel、phone、postal、email、money、url、date
例如:
eutils.checkType('13812560000', 'phone'); // 返回 true
etutil.checkType('aaaxxx', 'url'); // 返回false

detector

根据ua判断浏览器环境、版本号;

parse

调用方法,eutils.detector.parse(ua);

参数参数类型必填说明uaString否需要校验的ua,默认是navigator.userAgent返回

返回json,格式如下:

{ device: { name: "iphone", version: -1, fullVersion: "-1", [iphone]: -1 }, os: { name: "ios", version: 6.1, fullVersion: "6.1", [ios]: 6.1 }, browser: { name: "chrome": version: 26.0, fullVersion: "26.0.1410.50", mode: 26.0, fullMode: "26.0.1410.50", compatible: false, [chrome]: 26.0 }, engine: { name: "webkit", version: 536.26, fullVersion: "536.26", mode: 523.26, fullMode: "523.26", compatible: false, [webkit]: 536.26 }}csscommon

常用样式

word-nowrap: 文本-强制不换行word-wrap: 文本-强制换行ellipsis: 多出部分用省略号表示 , 用于一行ellipsis2: 多出部分用省略号表示 , 用于两行ellipsis3: 多出部分用省略号表示 , 用于三行flex: flex布局flex-center: flex布局,水平居中flex-middle: flex布局,垂直居中flex-cm: flex布局,垂直、水平都居中center: 在父元素中,水平、垂直居中;mask: 遮罩层bg: 背景图样式设置reset

为了保持各类浏览器初始样式的一致性,执行格式重置;

normalize.css

normalize.css v8.0.1
来源地址:github.com/necolas/normalize.css

参考工具集utils: https://github.com/cd-dongzi/utils (star 190,css js)工具集outils: https://github.com/proYang/outils (start 1189 js)