js-apis-uiappearance.md 2.4 KB
Newer Older
L
lingqst 已提交
1 2 3 4 5
# 用户界面外观

用户界面外观提供管理系统外观的一些基础能力,目前仅包括深浅色模式配置。

> **说明:**
B
benb365 已提交
6
>
L
lingqst 已提交
7
> 从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
B
benb365 已提交
8
>
B
benb365 已提交
9
> 本模块接口为系统接口。
L
lingqst 已提交
10 11 12 13


## 导入模块

B
benb365 已提交
14
```ts
L
lingqst 已提交
15 16 17 18 19 20 21 22 23
import uiAppearance from '@ohos.uiAppearance'
```


## DarkMode

深色模式枚举。


B
benb365 已提交
24 25
**系统能力:** SystemCapability.ArkUI.UiAppearance

L
lingqst 已提交
26 27 28 29 30 31 32 33
| 名称 | 值 | 说明 |
| -- | -- | -- |
| ALWAYS_DARK | 0 | 系统始终为深色。  |
| ALWAYS_LIGHT | 1 | 系统始终为浅色。 |


## uiAppearance.setDarkMode

B
benb365 已提交
34
setDarkMode(mode: DarkMode, callback: AsyncCallback\<void>): void
L
lingqst 已提交
35 36 37

设置系统深色模式。

B
benb365 已提交
38
**需要权限:** ohos.permission.UPDATE_CONFIGURATION
L
lingqst 已提交
39

B
benb365 已提交
40
**系统能力:** SystemCapability.ArkUI.UiAppearance
L
lingqst 已提交
41 42 43 44

**参数:** 
| 参数名 | 类型 | 必填 | 说明 |
| -- | -- | -- | -- |
B
benb365 已提交
45
| mode | [DarkMode](#darkmode) | 是 | 指定系统的深色模式配置 |
L
lingqst 已提交
46 47 48
| callback | AsyncCallback\<void>| 是 | 配置深色模式的异步回调 |

**示例:** 
B
benb365 已提交
49 50 51 52
  ```ts
uiAppearance.setDarkMode(uiAppearance.DarkMode.ALWAYS_DARK, (err) => {
  console.info(`${err}`);
})
L
lingqst 已提交
53 54 55 56 57 58 59 60 61
  ```


## uiAppearance.setDarkMode

setDarkMode(mode: DarkMode): Promise\<void>;

设置系统深色模式。

B
benb365 已提交
62
**需要权限:** ohos.permission.UPDATE_CONFIGURATION
L
lingqst 已提交
63

B
benb365 已提交
64
**系统能力:** SystemCapability.ArkUI.UiAppearance
L
lingqst 已提交
65 66 67 68

**参数:** 
| 参数名 | 类型 | 必填 | 说明 |
| -- | -- | -- | -- |
B
benb365 已提交
69
| mode | [DarkMode](#darkmode) | 是 | 指定系统深色模式配置 |
L
lingqst 已提交
70

71 72 73 74 75 76
**返回值:**

| 类型   | 说明                           |
| ------ | ------------------------------ |
| Promise\<void> | Promise对象。无返回结果的Promise对象。|

L
lingqst 已提交
77
**示例:** 
B
benb365 已提交
78
  ```ts
L
lingqst 已提交
79 80 81 82 83 84 85 86 87 88 89 90 91 92
uiAppearance.setDarkMode(uiAppearance.DarkMode.ALWAYS_DARK).then(() => {
    console.log('Set dark-mode successfully.');
}).catch((err) => {
    console.log(`Set dark-mode failed, ${err}`);
});
  ```


## uiAppearance.getDarkMode

getDarkMode(): DarkMode;

获取当前的深色模式配置。

B
benb365 已提交
93
**需要权限:** ohos.permission.UPDATE_CONFIGURATION
L
lingqst 已提交
94

B
benb365 已提交
95
**系统能力:** SystemCapability.ArkUI.UiAppearance
L
lingqst 已提交
96 97 98 99

**返回值:** 
| 类型 | 说明 |
| -- | -- |
B
benb365 已提交
100
|[DarkMode](#darkmode) | 系统当前的深色模式配置 |
L
lingqst 已提交
101 102

**示例:** 
B
benb365 已提交
103
  ```ts
L
lingqst 已提交
104 105 106
let darkMode = uiAppearance.getDarkMode();
console.log(`Get dark-mode ${darkMode}`);
  ```