harmony 鸿蒙@ohos.uiAppearance (UI Appearance) (System API)

2025-06-12
浏览 (3)

@ohos.uiAppearance (UI Appearance) (System API)

The uiAppearance module provides basic capabilities for managing the system appearance. It allows for color mode configuration currently, and will introduce more features over time.

NOTE

The APIs of this module are supported since API version 10. Updates will be marked with a superscript to indicate their earliest API version.

The APIs provided by this module are system APIs.

Modules to Import

import { uiAppearance } from '@kit.ArkUI'

DarkMode

Enumerates the color modes.

System capability: SystemCapability.ArkUI.UiAppearance

|Name|Value|Description| |–|–|–| |ALWAYS_DARK|0|The system is always in dark mode.| |ALWAYS_LIGHT|1|The system is always in light mode.|

uiAppearance.setDarkMode

setDarkMode(mode: DarkMode, callback: AsyncCallback<void>): void

Sets the system color mode. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.UPDATE_CONFIGURATION

System capability: SystemCapability.ArkUI.UiAppearance

Parameters

Error codes

For details about the error codes, see Universal Error Codes and UI Appearance Error Codes.

|ID|Error Message| |–|–| |201|Permission denied.| |401 |Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3. Parameter verification failed. | |500001|Internal error.|

Example

import { uiAppearance } from '@kit.ArkUI'
import { BusinessError } from '@kit.BasicServicesKit';
try {
    uiAppearance.setDarkMode(uiAppearance.DarkMode.ALWAYS_DARK, (error) => {
      if (error) {
        console.error('Set dark-mode failed, ' + error.message);
      } else {
        console.info('Set dark-mode successfully.');
      }
    })
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('Set dark-mode failed, ' + message);
}

uiAppearance.setDarkMode

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

Sets the system color mode. This API uses a promise to return the result.

Permission required: ohos.permission.UPDATE_CONFIGURATION

System capability: SystemCapability.ArkUI.UiAppearance

Parameters

|Name|Type|Mandatory|Description| |–|–|–|–| |mode|DarkMode|Yes|Color mode to set.|

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and UI Appearance Error Codes.

Example

import { uiAppearance } from '@kit.ArkUI'
import { BusinessError } from '@kit.BasicServicesKit';
try {
    uiAppearance.setDarkMode(uiAppearance.DarkMode.ALWAYS_DARK).then(() => {
      console.info('Set dark-mode successfully.');
    }).catch((error:Error) => {
      console.error('Set dark-mode failed, ' + error.message);
    });
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('Set dark-mode failed, ' + message);
}

uiAppearance.getDarkMode

getDarkMode(): DarkMode;

Obtains the system color mode.

Permission required: ohos.permission.UPDATE_CONFIGURATION

System capability: SystemCapability.ArkUI.UiAppearance

Return value

Error codes

For details about the error codes, see Universal Error Codes and UI Appearance Error Codes.

Example

import { uiAppearance } from '@kit.ArkUI'
import { BusinessError } from '@kit.BasicServicesKit';
try {
    let darkMode = uiAppearance.getDarkMode();
    console.info('Get dark-mode ' + darkMode);
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('Get dark-mode failed, ' + message);
}

uiAppearance.setFontScale¹²⁺

setFontScale(fontScale: number): Promise<void>

Sets the system font scale.

Permission required: ohos.permission.UPDATE_CONFIGURATION

System capability: SystemCapability.ArkUI.UiAppearance

System API: This is a system API.

Parameters

|Name|Type|Mandatory|Description| |–|–|–|–| |fontScale|number|Yes|Font scale to be set.|

Return value

Error codes

For details about the error codes, see Universal Error Codes and UI Appearance Error Codes.

|ID|Error Message| |–|–| |201|Permission denied.| |202|Permission verification failed. A non-system application calls a system API.| |401 |Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3. Parameter verification failed. | |500001|Internal error.|

Example

import { uiAppearance } from '@kit.ArkUI'
import { BusinessError } from '@kit.BasicServicesKit';

let fontScale = 10;

try {
    uiAppearance.setFontScale(fontScale).then(() => {
      console.info('Set fontScale successfully.');
    }).catch((error:Error) => {
      console.error('Set fontScale failed, ' + error.message);
    });
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('Set fontScale failed, ' + message);
}

uiAppearance.getFontScale¹²⁺

getFontScale(): number

Obtains the system font scale.

Permission required: ohos.permission.UPDATE_CONFIGURATION

System capability: SystemCapability.ArkUI.UiAppearance

System API: This is a system API.

Return value

Error codes

For details about the error codes, see Universal Error Codes and UI Appearance Error Codes.

Example

import { uiAppearance } from '@kit.ArkUI'
import { BusinessError } from '@kit.BasicServicesKit';
try {
    let fontScale = uiAppearance.getFontScale();
    console.info('Get fontScale ' + fontScale);
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('Get fontScale failed, ' + message);
}

uiAppearance.setFontWeightScale¹²⁺

setFontWeightScale(fontWeightScale: number): Promise<void>

Sets the system font weight scale.

Permission required: ohos.permission.UPDATE_CONFIGURATION

System capability: SystemCapability.ArkUI.UiAppearance

System API: This is a system API.

Parameters

|Name|Type|Mandatory|Description| |–|–|–|–| |fontWeightScale|number|Yes|Font weight scale to set.|

Return value

Error codes

For details about the error codes, see Universal Error Codes and UI Appearance Error Codes.

Example

import { uiAppearance } from '@kit.ArkUI'
import { BusinessError } from '@kit.BasicServicesKit';

let fontWeightScale = 1;

try {
    uiAppearance.setFontWeightScale(fontWeightScale).then(() => {
      console.info('Set fontWeightScale successfully.');
    }).catch((error:Error) => {
      console.error('Set fontWeightScale failed, ' + error.message);
    });
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('Set fontWeightScale failed, ' + message);
}

uiAppearance.getFontWeightScale¹²⁺

getFontWeightScale(): number

Obtains the system font weight scale.

Permission required: ohos.permission.UPDATE_CONFIGURATION

System capability: SystemCapability.ArkUI.UiAppearance

System API: This is a system API.

Return value

Error codes

For details about the error codes, see Universal Error Codes and UI Appearance Error Codes.

Example

import { uiAppearance } from '@kit.ArkUI'
import { BusinessError } from '@kit.BasicServicesKit';
try {
    let fontWeightScale = uiAppearance.getFontWeightScale();
    console.info('Get fontScale ' + fontWeightScale);
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('Get fontWeightScale failed, ' + message);
}