feat(device): Add getLanguageTag function (#939)

device/README.md

@@ -35,6 +35,7 @@ const logBatteryInfo = async () => {
 * [`getInfo()`](#getinfo)
 * [`getBatteryInfo()`](#getbatteryinfo)
 * [`getLanguageCode()`](#getlanguagecode)
+* [`getLanguageTag()`](#getlanguagetag)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
 
@@ -103,6 +104,21 @@ Get the device's current language locale code.
 --------------------
 
 
+### getLanguageTag()
+
+```typescript
+getLanguageTag() => Promise<LanguageTag>
+```
+
+Get the device's current language locale tag.
+
+**Returns:** <code>Promise&lt;<a href="#languagetag">LanguageTag</a>&gt;</code>
+
+**Since:** 4.0.0
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -147,6 +163,13 @@ Get the device's current language locale code.
 | **`value`** | <code>string</code> | Two character language code. | 1.0.0 |
 
 
+#### LanguageTag
+
+| Prop        | Type                | Description                                     | Since |
+| ----------- | ------------------- | ----------------------------------------------- | ----- |
+| **`value`** | <code>string</code> | Returns a well-formed IETF BCP 47 language tag. | 4.0.0 |
+
+
 ### Type Aliases
 
 

device/android/src/main/java/com/capacitorjs/plugins/device/DevicePlugin.java

@@ -63,4 +63,11 @@ public void getLanguageCode(PluginCall call) {
         ret.put("value", Locale.getDefault().getLanguage());
         call.resolve(ret);
     }
+
+    @PluginMethod
+    public void getLanguageTag(PluginCall call) {
+        JSObject ret = new JSObject();
+        ret.put("value", Locale.getDefault().toLanguageTag());
+        call.resolve(ret);
+    }
 }

device/ios/Plugin/Device.swift

@@ -66,6 +66,10 @@ import Foundation
         return String(Locale.preferredLanguages[0].prefix(2))
     }
 
+    public func getLanguageTag() -> String {
+        return String(Locale.preferredLanguages[0])
+    }
+
     public func getModelName() -> String {
         var size = 0
         sysctlbyname("hw.machine", nil, &size, nil, 0)

device/ios/Plugin/DevicePlugin.m

@@ -8,4 +8,5 @@
            CAP_PLUGIN_METHOD(getInfo, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getBatteryInfo, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getLanguageCode, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(getLanguageTag, CAPPluginReturnPromise);
 )

device/ios/Plugin/DevicePlugin.swift

@@ -64,4 +64,11 @@ public class DevicePlugin: CAPPlugin {
         ])
     }
 
+    @objc func getLanguageTag(_ call: CAPPluginCall) {
+        let tag = implementation.getLanguageTag()
+        call.resolve([
+            "value": tag
+        ])
+    }
+
 }

device/src/definitions.ts

@@ -143,6 +143,15 @@ export interface GetLanguageCodeResult {
   value: string;
 }
 
+export interface LanguageTag {
+  /**
+   * Returns a well-formed IETF BCP 47 language tag.
+   *
+   * @since 4.0.0
+   */
+  value: string;
+}
+
 export interface DevicePlugin {
   /**
    * Return an unique identifier for the device.
@@ -171,6 +180,13 @@ export interface DevicePlugin {
    * @since 1.0.0
    */
   getLanguageCode(): Promise<GetLanguageCodeResult>;
+
+  /**
+   * Get the device's current language locale tag.
+   *
+   * @since 4.0.0
+   */
+  getLanguageTag(): Promise<LanguageTag>;
 }
 
 /**

device/src/web.ts

@@ -6,6 +6,7 @@ import type {
   DeviceInfo,
   DevicePlugin,
   GetLanguageCodeResult,
+  LanguageTag,
 } from './definitions';
 
 declare global {
@@ -71,6 +72,12 @@ export class DeviceWeb extends WebPlugin implements DevicePlugin {
     };
   }
 
+  async getLanguageTag(): Promise<LanguageTag> {
+    return {
+      value: navigator.language,
+    };
+  }
+
   parseUa(ua: string): any {
     const uaFields: any = {};
     const start = ua.indexOf('(') + 1;