工具函数
@ns/utils 里是组件库自己用到的一些小工具,也从 @ns/ui 一并导出,业务代码可以直接用:
ts
import { debounce, isEmpty, addClass } from '@ns/ui'
// 或
import { debounce, isEmpty, addClass } from '@ns/utils'
类型判断
| 函数 | 说明 |
|---|---|
isString(val)、isNumber(val)、isBoolean(val)、isFunction(val) | 判断基本类型 |
isArray(val) | 等同于 Array.isArray |
isObject(val) | 不是 null 且 typeof 为 object(数组也算) |
isEmpty(val) | null、undefined、空字符串、空数组、没有属性的普通对象返回 true;Map、Set 按 size 判断;数字 0、false、Date 等其他值返回 false |
函数和字符串
| 函数 | 说明 |
|---|---|
debounce(fn, delay) | 防抖:连续调用时只在最后一次调用之后 delay 毫秒执行一次 |
throttle(fn, delay) | 节流:第一次调用立即执行,间隔内的最后一次调用在间隔结束时补执行 |
noop() | 空函数 |
identity(val) | 原样返回参数 |
capitalize(str) | 首字母大写:'button' → 'Button' |
camelize(str) | 短横线转驼峰:'date-picker' → 'datePicker' |
kebabCase(str) | 驼峰转短横线:'datePicker' → 'date-picker' |
ts
import { debounce } from '@ns/ui'
const search = debounce((keyword: string) => {
// 停止输入 300 毫秒后才真正发请求
}, 300)
debounce 和 throttle 返回的函数带 cancel(),组件卸载时调用它取消还没执行的那一次;作为对象方法调用时,this 会传给原函数。
DOM
| 函数 | 说明 |
|---|---|
isClient | 常量,是否在浏览器环境 |
inBrowser() | 同上,函数形式 |
isDocumentVisible() | 当前页面是否可见(没被切到后台) |
isWindow(val) | 是不是 window 对象 |
addEventListener(el, event, handler, options?)、removeEventListener(...) | 带类型的事件绑定和解绑,事件名按目标区分(window 上能用 beforeunload,document 上能用 visibilitychange) |
getComputedStyle(el) | 取元素的计算样式 |
getScrollTop(el)、setScrollTop(el, value) | 读写滚动位置,el 可以是元素或 window |
getOffset(el) | 元素相对整个文档的 top、left |
addClass(el, ...classes)、removeClass(el, ...classes)、hasClass(el, className)、toggleClass(el, className, force?) | 类名操作 |
类型
ts
import type { ComponentSize, ComponentType, MaybeArray, Nullable } from '@ns/ui'
type ComponentSize = 'large' | 'default' | 'small'
type ComponentType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'help' | 'default'
type MaybeArray<T> = T | T[]
type MaybeFunction<T> = T | (() => T)
type Nullable<T> = T | null
type Optional<T> = T | undefined