#getWindowInfoSync
获取窗口信息。
#扫码预览
#支持版本
前端库版本不低于 0.0.18。
#支持平台
| 平台 | 支持情况 |
|---|---|
| Android | 支持 |
| iOS | 支持 |
| PC | 不支持 |
| HarmonyOS | 不支持 |
#支持场景
| 场景 | 支持情况 |
|---|---|
| 页面 | 支持 |
| 卡片 | 不支持 |
#调用方式
#同步 API
getWindowInfoSync(_params?: object): GetWindowInfoResult#入参
无。
#调用示例
import { getWindowInfoSync } from '@doubao-dev/framework/api';
const result = getWindowInfoSync();
console.log(result.windowWidth, result.windowHeight);
console.log(result.safeArea?.top, result.screenTop);#返回值
| 名称 | 类型 | 必返 | 说明 |
|---|---|---|---|
pixelRatio | number | 是 | 设备像素比 |
safeArea | WindowSafeArea | 否 | 安全区域 |
safeArea.bottom | number | 否 | 安全区域右下角纵坐标 |
safeArea.height | number | 否 | 安全区域高度 |
safeArea.left | number | 否 | 安全区域左上角横坐标 |
safeArea.right | number | 否 | 安全区域右下角横坐标 |
safeArea.top | number | 否 | 安全区域左上角纵坐标 |
safeArea.width | number | 否 | 安全区域宽度 |
screenHeight | number | 是 | 屏幕高度 |
screenTop | number | 是 | 窗口上边缘的 y 值 |
screenWidth | number | 是 | 屏幕宽度 |
statusBarHeight | number | 是 | 状态栏高度 |
windowHeight | number | 是 | 可使用窗口高度 |
windowWidth | number | 是 | 可使用窗口宽度 |
#返回示例
{
"pixelRatio": 3,
"screenWidth": 393,
"screenHeight": 852,
"windowWidth": 393,
"windowHeight": 852,
"statusBarHeight": 59,
"safeArea": {
"left": 0,
"right": 393,
"top": 59,
"bottom": 818,
"width": 393,
"height": 759
},
"screenTop": 0
}