https://github.com/txs1992/mt-utils
一些业务中常用的工具函数，Some commonly used tool functions in business.
https://github.com/txs1992/mt-utils
business css-supports get-scroll-element is-object is-scroll-element object-serialization util utils
Last synced: 20 days ago
JSON representation
一些业务中常用的工具函数，Some commonly used tool functions in business.
- Host: GitHub
- URL: https://github.com/txs1992/mt-utils
- Owner: txs1992
- License: mit
- Created: 2019-04-04T07:08:03.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T19:14:56.000Z (about 3 years ago)
- Last Synced: 2025-10-10T17:12:50.450Z (4 months ago)
- Topics: business, css-supports, get-scroll-element, is-object, is-scroll-element, object-serialization, util, utils
- Language: JavaScript
- Homepage:
- Size: 257 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
mt-utils
> 一个业务中常用的工具函数的封装库
## npm 使用示例
```js
import { cssSupports } from 'mt-utils'
cssSupports('position')
```
## CDN 使用示例
```html
window.MtUtils.cssSupports('position')
```
## 功能目录
- [CSS 能力检测](#csssupports-css-能力检测)
- [判断对象](#isObject-判断是否是对象)
- [对象序列化](#obj2qs-对象转换查询字符串)
- [判断滚动元素](#isScrollElement-判断滚动元素)
- [获取第一个子级滚动元素](#getScrollElementOfFirstChild-获取第一个子级滚动元素)
- [获取第一个父级滚动元素](#getScrollElementOfFirstParent-获取第一个父级滚动元素)
- [获取周的最后一天](#getEndDateOfWeek-获取周的最后一天)
- [驼峰转短横线](#camelToKebab-驼峰转短横线)
- [短横线转驼峰](#kebabToCamel-短横线转驼峰)
#### cssSupports CSS 能力检测
- **参数**
- `prop` : `String` css 属性名称
- `value`: [`String` | `undefined`] css 属性值
- **返回值** Boolean
- **描述**
> 判断浏览器是否支持传入的的 css 属性，以及对应的 css 属性值。如果不传 value 参数，只判断是否支持 css 属性，否则判断是否支持属性与值。
- **示例**
```js
// 检测是否支持 position 属性
cssSupports('position')
// 判断是否支持 sticky 定位
cssSupports('position', 'sticky')
```
[返回目录](#功能目录)
### isObject 判断是否是对象
- **参数**
- `value` : `Obejct`
- **返回值** Boolean
- **描述**
> 根据给定的值，判断是否是对象
- **示例**
```js
// 判断传入的值是不是一个对象。
isObject({})
```
[返回目录](#功能目录)
### obj2qs 对象转换查询字符串
- **参数**
- `obj` : `Obejct`
- `first`: `Boolean` 是否添加 `&` 符号，默认不添加
- `transcoding`: `Boolean` 是否对值进行 encodeURIComponent 转码，默认开启转码。
- **返回值** Boolean
- **描述**
> 根据给定的对象将其转换成查询字符串，如果传入的不是对象返回空字符串。有些时候我们需要必须通过 get 请求将对象或是数组等参数传递给接口，例如下载数据，而直接传递对象接口可能无法解析，所以需要将参数序列化。
- **示例**
```js
// 默认调用，即不添加 ？ 连接符，并转码。
obj2qs({ name: 'mt', age: 10, ids: [1, 2, 3], map: { a: 'b', b: 'c' } })
// 转换结果："name=mt&age=10&ids=%5B1%2C2%2C3%5D&map=%7B%22a%22%3A%22b%22%2C%22b%22%3A%22c%22%7D"
// 不添加 ？ 连接符，并且不转码。
obj2qs(
{ name: 'mt', age: 10, ids: [1, 2, 3], map: { a: 'b', b: 'c' } },
false,
false
)
// 转换结果："name=mt&age=10&ids=[1,2,3]&map={"a":"b","b":"c"}"
// 添加 ? 连接符，并开启转码
obj2qs(
{ name: 'mt', age: 10, ids: [1, 2, 3], map: { a: 'b', b: 'c' } },
true,
true
)
// 转换结果："?name=mt&age=10&ids=%5B1%2C2%2C3%5D&map=%7B%22a%22%3A%22b%22%2C%22b%22%3A%22c%22%7D"
```
[返回目录](#功能目录)
#### isScrollElement 判断滚动元素
- **参数**
- `el` : `Element` DOM 元素
- `direction`: `String` 水平或者垂直滚动，默认 vertical。
- `可选值`: [`vertical`, `horizontal`]
- **返回值** Boolean
- **描述**
> 根据给定的 DOM 元素判断该元素是否是一个滚动元素。
- **示例**
```js
// 判断 body 是否是一个滚动元素。
isScrollElement(document.body, 'vertical')
```
[返回目录](#功能目录)
### getScrollElementOfFirstChild 获取第一个子级滚动元素
- **参数**
- `el` : `Element` DOM 元素
- `direction`: `String` 水平或者垂直滚动，默认 vertical。
- `可选值`: [`vertical`, `horizontal`]
- **返回值** [`Element`, `null`]
- **描述**
> 根据给定的 DOM 元素，获取距离该元素最近的子级动元素(会一直向下查找到最后一级)，如果该元素的子级元素中没有滚动元素，则返回 null。
- **示例**
```js
getScrollElementOfFirstChild(document.querySelector('.content'), 'vertical')
```
[返回目录](#功能目录)
### getScrollElementOfFirstParent 获取第一个父级滚动元素
- **参数**
- `el` : `Element` DOM 元素
- `direction`: `String` 水平或者垂直滚动，默认 vertical。
- `可选值`: [`vertical`, `horizontal`]
- **返回值** [`Element`, `null`]
- **描述**
> 根据给定的 DOM 元素，获取距离该元素最近的父级滚动元素(向上查找到最顶级)，如果该元素的父级元素中没有滚动元素，则返回 null。
- **示例**
```js
getScrollElementOfFirstParent(document.querySelector('.content'), 'vertical')
```
[返回目录](#功能目录)
### getEndDateOfWeek 获取周的最后一天
- **参数**
- `date` : `Date` 日期对象
- `startDay`: `Number` 周的开始日期，国内是从周一开始，而国外是从周末开始。
- **返回值** `Date`
- **描述**
> 根据给定的日期对象返回当前周的最后一天
- **示例**
```js
getEndDateOfWeek(new Date())
```
[返回目录](#功能目录)
### camelToKebab 驼峰转短横线
- **参数**
- `str` : `String` 需要转换的字符串
- **返回值** `String`
- **描述**
> 根据给定的驼峰格式字符串返回短横线格式字符串
- **示例**
```js
camelToKebab('MtUtils') // 返回 mt-utils
```
[返回目录](#功能目录)
### kebabToCamel 短横线转驼峰
- **参数**
- `str` : `String` 需要转换的字符串
- **返回值** `String`
- **描述**
> 根据给定的短横线格式字符串返回驼峰格式字符串
- **示例**
```js
kebabToCamel('mt-utils') // 返回 MtUtils
```
[返回目录](#功能目录)