JView UI

Appearance

Home > @jview/utils

utils package ​

@jview/utils封装了 JView UI 产品中常用的一些工具函数。这些工具函数也不仅限于 JView UI 产品中使用。

Enumerations ​

EnumerationDescription
DataType数据类型枚举

Functions ​

FunctionDescription
camelize(str)中横线写法转驼峰写法
capitalize(str)首字母大写
enterFullscreen(element, options)进入全屏，可参考 https://developer.mozilla.org/zh-CN/docs/Web/API/Element/requestFullScreen。 存在 top-layer 叠加问题，如果要规避叠加顺序带来的问题，需要手动判断全屏状态，如果当前已经是全屏状态，可以先退出全屏，再让目标元素进入全屏。
exitFullscreen()退出全屏，可参考 https://developer.mozilla.org/en-US/docs/Web/API/Document/exitFullscreen
getDescentdantKeysByKey(nodes, key, mapper, results)
getDescentdantsByKey(nodes, key, mapper, results)
getDescentdantsByNode(node, mapper, results)
getFullscreenElement()获取全屏元素
getOffset(el, relativeNode)获取一个元素的 offset 信息
getTreeNodeByKey(nodes, key, mapper)根据目标 key 值找到
getType(val)判断变量的数据类型
installAll(app, comps)注册多个全局组件
isArray(val)是否是数组类型
isBasicType(val)是否是基础类型
isBlob(val)是否是 Blob 类型
isBool(val)是否是布尔类型
isDefined(val)判断变量是否有具体定义，即非null,非undefined
isFile(val)是否是 File 类型，File 类型也是 Blob 的子类型
isFullscreen()判断当前是否是全屏状态
isFullscreenEnabled()判断浏览器当前状态是否允许进入全屏
isFunction(val)是否是函数类型
isJSONArrayString(val)是否是JSON数组字符串
isJSONObjectString(val)是否是JSON对象字符串
isJSONString(val)是否是JSON字符串，空字符串也认为是合法的
isMap(val)是否是 map 类型
isNull(val)是否是 null 类型
isNumber(val)是否是数值类型
isObject(val)是否是对象 object 类型
isPromise(val)是否是 Promise 类型
isSameUrl(url1, url2)判断两个 url 是否指向相同的资源，会自动去掉协议部分再比较
isSet(val)是否是 set 类型
isString(val)是否是字符串类型
isSymbol(val)是否是 symbol 类型
isUndefined(val)是否是 undefined 类型
isUndefOrNull(val)是否是 undefined 或 null 类型
kebablize(str)转为中横线写法
listenFullscreen(callback, options)监听全屏变化事件
loadScript(options)加载一个脚本
pascalize(str)转为 Pascal 写法，即大驼峰写法
patchF11DefaultAction()阻止F11按键的默认行为，并根据当前的全屏状态调用进入/退出全屏，解决通过F11按键和API两种方式进入全屏时出现的状态不一致问题。
sleep(seconds)睡眠等待
unlistenFullscreen(callback, options)移除监听全屏变化事件
withInstall(comp, onAfterInstall)给一个组件加上 install 方法，让它能够作为插件被使用

Interfaces ​

InterfaceDescription
EnhancedDocument增强 Document，加上一些全屏类方法
EnhancedHTMLElement增强 HTMLElement，加上一些全屏类方法
EnhanceScriptElement补足 script 元素的一些属性和方法
LoadScriptOptionloadScript 函数支持的参数类型
OffsetResponsegetOffset 函数的返回类型，表示偏移量

Type Aliases ​

Type AliasDescription
BasicType一个类型别名，代表基础类型
FieldMapper字段映射配置
GeneralFunction通用的函数类型
SFCWithInstallSFC组件类型的基础上加上install方法，使之成为一个标准的插件
TreeNode树节点基本类型

Copyright © 2022-2024 All Rights Reserved by Tusi.