跳到主要内容
版本：0.78

外观

tsx
import {Appearance} from 'react-native';

Appearance 模块暴露了关于用户外观偏好的信息，例如他们首选的颜色方案（浅色或深色）。

开发者说明​

Appearance API 灵感来自 W3C 的 媒体查询草案。颜色方案偏好是仿照 prefers-color-scheme CSS 媒体特性 建模的。

示例​

你可以使用 Appearance 模块来确定用户是否偏好深色颜色方案：

tsx
const colorScheme = Appearance.getColorScheme();
if (colorScheme === 'dark') {
  // 使用深色颜色方案
}

虽然颜色方案立即可用，但这可能会发生变化（例如在日出或日落时计划的颜色方案更改）。任何依赖于用户首选颜色方案的渲染逻辑或样式都应尝试在每次渲染时调用此函数，而不是缓存该值。例如，你可以使用 useColorScheme React hook，因为它提供并订阅颜色方案更新，或者你可以使用内联样式而不是在 StyleSheet 中设置值。

参考

方法​

getColorScheme()​

tsx
static getColorScheme(): 'light' | 'dark' | null;

表示当前用户首选的颜色方案。该值可能会稍后更新，要么通过直接用户操作（例如设备设置中的主题选择或通过 setColorScheme 选择的应用程序级用户界面样式），要么按计划（例如遵循白天/夜晚循环的浅色和深色主题）。

支持的颜色方案：

  • light：用户偏好浅色主题。
  • dark：用户偏好深色主题。
  • null：用户未指示首选颜色主题。

另见：useColorScheme hook。

注意：使用 Chrome 调试时，getColorScheme() 将始终返回 light。

setColorScheme()​

tsx
static setColorScheme('light' | 'dark' | null): void;

强制应用程序始终采用浅色或深色界面样式。默认值为 null，这会导致应用程序继承系统的界面样式。如果分配不同的值，新样式将应用于应用程序及其中的所有原生元素（Alerts, Pickers 等）。

支持的颜色方案：

  • light：应用浅色用户界面样式。
  • dark：应用深色用户界面样式。
  • null：遵循系统的界面样式。

注意：此更改不会影响系统选择的界面样式或在其他应用程序中设置的任何样式。

addChangeListener()​

tsx
static addChangeListener(
  listener: (preferences: {colorScheme: 'light' | 'dark' | null}) => void,
): NativeEventSubscription;

添加一个当外观偏好更改时触发的事件处理程序。