工具函数 UniApp
对 uni-app
一些 api
的封装,为了方便使用。
函数列表
函数名 | 说明 | 版本 |
---|---|---|
uniGetNodeRectInfo | 获取单个节点布局信息 | - |
uniGetNodesRectInfo | 获取多个节点节点布局信息 | - |
uniGetPagesData | 获取所有在 pages.json 中定义的页面数据 | - |
uniGetTabBarData | 获取在 pages.json 中定义的 tabBar 数据 | - |
uniGetPageData | 获取指定页面在 pages.json 中定义的数据 | - |
uniGetCurrentPageData | 获取当前页面在 pages.json 中定义的数据 | - |
uniIsTabBar | 验证数据是否是秒级时间戳 | - |
isMillisecondTimestamp | 判断当前页面或指定页面路径对应的页面是否是 tabBar 页面 | - |
uniIsPageExist | 判断页面是否在 pages.json 中定义 | - |
uniGetNodeRectInfo
获取单个节点布局信息。
参数
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
selector | 节点 id 或 class | String | - | - |
instance | 组件实例 | getCurrentInstance | - | - |
提示
instance
参数不能直接传 getCurrentInstance()
,这是因为在实际开发中发现如果直接传递 getCurrentInstance()
会不能正确获取数据,不知道时什么原因,解决方式是先定义一个变量接收 getCurrentInstance()
后该变量。
返回值
返回一个 Promise
对象,该 Promise
的 resolve()
函数的参数为节点布局信息对象,参考。
uniGetNodesRectInfo
获取多个节点节点布局信息。
参数
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
selector | 节点 id 或 class | String | - | - |
instance | 组件实例 | getCurrentInstance | - | - |
提示
instance
参数不能直接传 getCurrentInstance()
,这是因为在实际开发中发现如果直接传递 getCurrentInstance()
会不能正确获取数据,不知道时什么原因,解决方式是先定义一个变量接收 getCurrentInstance()
后该变量。
返回值
返回一个 Promise
对象,该 Promise
的 resolve()
函数的参数为节点布局信息对象数组,参考。
uniGetPagesData
获取所有在 pages.json
中定义的页面数据。
提示
包含主包和所有分包
参数
无
返回值
返回在 pages.json
中定义的页面数据,格式为 Array
,包含主包和所有分包;
uniGetTabBarData
获取在 pages.json 中定义的 tabBar 数据。
提示
不包括数组、函数、null
等
参数
无
返回值
如果在 pages.json
中定义了 tabBar
数据,返回 tabBar
数据对象,否则返回 null
。
uniGetPageData
获取指定页面在 pages.json 中定义的数据。
参数
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
url | 页面的 URL | String | "" | - |
返回值
如果页面在 pages.json 中定义,返回页面在 pages.json
中定义的数据对象,否则返回 undefined
。
uniGetCurrentPageData
获取当前页面在 pages.json 中定义的数据。
参数
无
返回值
返回当前页面在 pages.json
中定义的数据对象。
uniIsTabBar
判断当前页面或指定页面路径对应的页面是否是 tabBar
页面。
参数
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
pagePath | 页面路径,如果该参数为空,那么判断当前页面是否是 tabBar 页面 | String | "" | - |
返回值
true
: 是 tabBar
页面; false
: 不是 tabBar
页面;
uniIsPageExist
判断页面是否在 pages.json
中定义。
参数
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
pagePath | 页面路径 | String | - | - |
返回值
true
: 页面存在;false
: 页面不存在;