Dimensions

info

对于 React 组件，useWindowDimensions 是首选 API。与 Dimensions 不同，它会在窗口尺寸更新时同步更新。这种方式也更符合 React 的编程范式。

React TSX

import {Dimensions} from 'react-native';

你可以使用下面的代码获取应用窗口的宽度和高度：

React TSX

const windowWidth = Dimensions.get('window').width;
const windowHeight = Dimensions.get('window').height;

note

尽管尺寸信息会立即可用，但它们可能发生变化（例如设备旋转、可折叠设备等），因此任何依赖这些常量的渲染逻辑或样式，都应尽量在每次渲染时调用此函数，而不是缓存其值（例如，使用内联样式，而不是把值写死在 StyleSheet 中）。

如果你的目标设备是可折叠设备，或者设备的屏幕尺寸、应用窗口尺寸可能发生变化，可以像下面的示例一样使用 Dimensions 模块提供的事件监听器。

示例

参考

方法

addEventListener()

React TSX

static addEventListener(
  type: 'change',
  handler: ({
    window,
    screen,
  }: DimensionsPayload) => void,
): EventSubscription;

添加一个事件监听函数。目前支持的事件有：

• change：在Dimensions对象内部的属性发生变化时触发。事件处理程序的参数是一个DimensionsPayload对象。

---

get()

React TSX

static get(dim: string): DisplayMetrics | DisplayMetricsAndroid;

初始尺寸在调用 runApplication 之前设置，因此在运行任何其他 require 之前应该可用，但可能会在之后更新。

示例：const {height, width} = Dimensions.get('window');

参数:

名称	类型	描述
dim 必需	字符串	调用 set 时定义的尺寸的名称。返回该尺寸的值。

note

对于 Android，window 尺寸将不包括状态栏（如果不透明）和底部导航栏占用的大小。

---

类型定义

DimensionsPayload

属性:

名称	类型	描述
window	DisplayMetrics	可见应用窗口的大小。
screen	DisplayMetrics	设备屏幕的大小。
windowPhysicalPixels	DisplayMetricsAndroid	Android 窗口的物理像素。
screenPhysicalPixels	DisplayMetricsAndroid	Android 屏幕的物理像素。

DisplayMetrics

类型
对象

属性:

名称	类型
width	number
height	number
scale	number
fontScale	number

DisplayMetricsAndroid

DisplayMetricsAndroid 包含 DisplayMetrics 的全部属性，以及以下属性：

名称	类型
densityDpi	number