We use essential cookies for the website to function, as well as analytics cookies for analyzing and creating statistics of the website performance. To agree to the use of analytics cookies, click "Accept All". You can manage your preferences at any time by clicking "Cookie Settings" on the footer. More Information.

Cookie Settings
Only Essential Cookies
Accept All
MaterialsConsole

HarmonyOS

输入关键字搜索
HMS Core
AppGallery Connect
HUAWEI HiAI
CTRL+K
Advanced filters
API versionAll
DeviceAll
Atomic service APIsNot filter by this
ReferencesApplication FrameworkArkUIArkTS APIDeprecated APIs@system.configuration (Application Configuration)

@system.configuration (Application Configuration)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+Lite Wearable12+
Last updated: 2026-09-04 06:52
Content overview
NOTE

  • The APIs of this module are deprecated since API version 7. You are advised to use @ohos.i18n and @ohos.intl instead.

  • The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

Collapse
Word wrap
Dark theme
Copy code
  1. import Configuration from '@system.configuration';

configuration.getLocale

Phone12+PC/2in113+Tablet12+TV19+Wearable18+Lite Wearable12+

static getLocale(): LocaleResponse

Obtains the current locale of the application, which is the same as the system locale.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.ArkUI.ArkUI.Lite

Return value

Expand
Type Description
LocaleResponse Current locale information.

Example

ArkTS example:

Collapse
Word wrap
Dark theme
Copy code
  1. export default {
  2.   getLocale() {
  3.     const localeInfo = configuration.getLocale();
  4.     console.info(localeInfo.language);
  5.   }
  6. }

JS example:

Collapse
Word wrap
Dark theme
Copy code
  1. <!-- xxx.hml -->
  2. <div class="container">
  3.     <text class="title" style="font-size: {{fontSize}}; color: {{fontColor}};">
  4.         configuration.getLocale example
  5.     </text>
  6.     <div class="section">
  7.         <text class="section-title">Language Settings:</text>
  8.         <div class="info-item">
  9.             <text class="value">{{language}}</text>
  10.         </div>
  11.     </div>
  12.     <div class="section">
  13.         <text class="section-title">Region Settings:</text>
  14.         <div class="info-item">
  15.             <text class="value">{{countryOrRegion}}</text>
  16.         </div>
  17.     </div>
  18.     <div class="section">
  19.         <text class="section-title">Layout direction:</text>
  20.         <div class="info-item">
  21.             <text class="value">{{dir}}</text>
  22.         </div>
  23.     </div>
  24.     <input type="button" value="Refresh configuration" style="width: 350px; height: 50px; margin: 5px;" onclick="getLocaleInfo"></input>
  25. </div>
Collapse
Word wrap
Dark theme
Copy code
  1. /* xxx.css */
  2. .container {
  3.     display: flex;
  4.     flex-direction: column;
  5.     align-items: center;
  6.     left: 0px;
  7.     top: 0px;
  8.     width: 454px;
  9.     height: 454px;
  10.     background-color: #000000;
  11. }
  12. .title {
  13.     font-size: 24px;
  14.     text-align: center;
  15.     width: 320px;
  16.     height: 100px;
  17.     margin-top: 40px;
  18.     color: #ffffff;
  19. }
  20. .section {
  21.     width: 400px;
  22.     height: 60px;
  23.     padding: 15px;
  24.     background-color: #1a1a1a;
  25.     border-radius: 10px;
  26. }
  27. .section-title {
  28.     font-size: 24px;
  29.     color: #007dff;
  30.     height: 35px;
  31.     margin-bottom: 10px;
  32. }
  33. .info-item {
  34.     width: 100%;
  35.     height: 35px;
  36. }
  37. .label {
  38.     font-size: 24px;
  39.     height: 40px;
  40.     color: #aaaaaa;
  41. }
  42. .value {
  43.     font-size: 24px;
  44.     height: 40px;
  45.     color: #ffffff;
  46. }
Collapse
Word wrap
Dark theme
Copy code
  1. // xxx.js
  2. import configuration from '@system.configuration';
  3. 

  4. export default {
  5.     data: {
  6.         fontSize: '28px',
  7.         fontColor: '#ffffff',
  8.         language: '',
  9.         countryOrRegion: '',
  10.         dir: '',
  11.         displayLanguage: '',
  12.         displayRegion: '',
  13.         displayDir: ''
  14.     },
  15.     onInit() {
  16.         this.getLocaleInfo();
  17.     },
  18.     getLocaleInfo() {
  19.         try {
  20.             const localeInfo = configuration.getLocale();
  21.             console.info('configuration.getLocale success');
  22.             console.info('language: ' + localeInfo.language);
  23.             console.info('countryOrRegion: ' + localeInfo.countryOrRegion);
  24.             console.info('dir: ' + localeInfo.dir);
  25.             
  26.             this.language = localeInfo.language || 'Unknown';
  27.             this.countryOrRegion = localeInfo.countryOrRegion || 'Unknown';
  28.             this.dir = localeInfo.dir || 'Unknown';
  29.             
  30.             this.displayLanguage = this.getDisplayLanguage(this.language);
  31.             this.displayRegion = this.getDisplayRegion(this.countryOrRegion);
  32.             this.displayDir = this.getDisplayDirection(this.dir);
  33.         } catch (error) {
  34.             console.error('configuration.getLocale failed: ' + error.message);
  35.             this.language = 'Failed';
  36.             this.countryOrRegion = 'Failed';
  37.             this.dir = 'Failed';
  38.             this.displayLanguage = 'Failed';
  39.             this.displayRegion = 'Failed';
  40.             this.displayDir = 'Failed';
  41.         }
  42.     },
  43.     getDisplayLanguage(language) {
  44.         const map = {
  45.             'zh': 'Chinese',
  46.             'en': 'English',
  47.             'ja': 'Japanese',
  48.             'ko': 'Korean'
  49.         };
  50.         return map[language] || language;
  51.     },
  52.     getDisplayRegion(region) {
  53.         const map = {
  54.             'CN': 'China',
  55.             'US': 'United States',
  56.             'JP': 'Japan',
  57.             'KR': 'South Korea'
  58.         };
  59.         return map[region] || region;
  60.     },
  61.     getDisplayDirection(dir) {
  62.         if (dir === 'ltr') {
  63.             return 'Left to Right';
  64.         } else if (dir === 'rtl') {
  65.             return 'Right to Left';
  66.         }
  67.         return dir;
  68.     }
  69. }

LocaleResponse

Phone12+PC/2in113+Tablet12+TV19+Wearable18+Lite Wearable12+

Defines attributes of the current locale.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.ArkUI.ArkUI.Lite

Expand
Name Type Readable Writable Description
language string Yes No Language, for example, zh.
countryOrRegion string Yes No Country or region, for example, CN.
dir string Yes No

Text layout direction. Available values are as follows:

- ltr: from left to right

- rtl: from right to left
@system.app (Application Context)
@system.mediaquery (Media Query)
English
©2026 HUAWEI Developers. All rights reserved.
Terms of Use
Statement About HUAWEI Developers and Privacy
Cookies
Cookie Settings
Open-Source Software Notice