• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 用户界面外观
2
3用户界面外观提供管理系统外观的一些基础能力,目前仅包括深浅色模式配置。
4
5> **说明:**
6>
7> 从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8>
9> 本模块接口为系统接口。
10
11
12## 导入模块
13
14```ts
15import uiAppearance from '@ohos.uiAppearance'
16```
17
18
19## DarkMode
20
21深色模式枚举。
22
23
24**系统能力:** SystemCapability.ArkUI.UiAppearance
25
26| 名称 | 值 | 说明 |
27| -- | -- | -- |
28| ALWAYS_DARK | 0 | 系统始终为深色。  |
29| ALWAYS_LIGHT | 1 | 系统始终为浅色。 |
30
31
32## uiAppearance.setDarkMode
33
34setDarkMode(mode: DarkMode, callback: AsyncCallback\<void>): void
35
36设置系统深色模式。
37
38**需要权限:** ohos.permission.UPDATE_CONFIGURATION
39
40**系统能力:** SystemCapability.ArkUI.UiAppearance
41
42**参数:**
43| 参数名 | 类型 | 必填 | 说明 |
44| -- | -- | -- | -- |
45| mode | [DarkMode](#darkmode) | 是 | 指定系统的深色模式配置 |
46| callback | AsyncCallback\<void>| 是 | 配置深色模式的异步回调 |
47
48**示例:**
49  ```ts
50uiAppearance.setDarkMode(uiAppearance.DarkMode.ALWAYS_DARK, (err) => {
51  console.info(`${err}`);
52})
53  ```
54
55
56## uiAppearance.setDarkMode
57
58setDarkMode(mode: DarkMode): Promise\<void>;
59
60设置系统深色模式。
61
62**需要权限:** ohos.permission.UPDATE_CONFIGURATION
63
64**系统能力:** SystemCapability.ArkUI.UiAppearance
65
66**参数:**
67| 参数名 | 类型 | 必填 | 说明 |
68| -- | -- | -- | -- |
69| mode | [DarkMode](#darkmode) | 是 | 指定系统深色模式配置 |
70
71**返回值:**
72
73| 类型   | 说明                           |
74| ------ | ------------------------------ |
75| Promise\<void> | Promise对象。无返回结果的Promise对象。|
76
77**示例:**
78  ```ts
79uiAppearance.setDarkMode(uiAppearance.DarkMode.ALWAYS_DARK).then(() => {
80    console.log('Set dark-mode successfully.');
81}).catch((err) => {
82    console.log(`Set dark-mode failed, ${err}`);
83});
84  ```
85
86
87## uiAppearance.getDarkMode
88
89getDarkMode(): DarkMode;
90
91获取当前的深色模式配置。
92
93**需要权限:** ohos.permission.UPDATE_CONFIGURATION
94
95**系统能力:** SystemCapability.ArkUI.UiAppearance
96
97**返回值:**
98| 类型 | 说明 |
99| -- | -- |
100|[DarkMode](#darkmode) | 系统当前的深色模式配置 |
101
102**示例:**
103  ```ts
104let darkMode = uiAppearance.getDarkMode();
105console.log(`Get dark-mode ${darkMode}`);
106  ```