@skippay/capacitor-localization-settings/README.md

Capacitor module to expose per-app language preferences API on iOS and Android.

# @skippay/capacitor-localization-settings

Capacitor module to expose per-app language preferences API on iOS and Android.

## Version Compatibility

| Plugin Version | Capacitor Version |
|----------------|-------------------|
| 1.x            | 8.x               |
| 0.0.x          | 5.x               |

## Install

```bash
npm install @skippay/capacitor-localization-settings
npx cap sync
```

## API

<docgen-index>

* [`getLanguage()`](#getlanguage)
* [`setLanguage(...)`](#setlanguage)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### getLanguage()

```typescript
getLanguage() => Promise<{ value: string; }>
```

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

--------------------


### setLanguage(...)

```typescript
setLanguage(options: { value: string; }) => Promise<{ value: string; }>
```

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ value: string; }</code> |

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

--------------------

</docgen-api>


## Define supported languages

To get started, you'll need to define the languages that your app supports.

### iOS

Open your project in XCode, in Project Navigator select project, go to `Info` tab, and
under `Localizations` section add languages you want to support.

![XCode screenshot](docs/configuration-xcode-1.png)

Next, you need to create a `Localization.strings` file.

![XCode screenshot](docs/configuration-xcode-2.png)

Select newly created file and on the right side of the screen, under `Localizations` selection press `Localize`. Confirm
the popup.

![XCode screenshot](docs/configuration-xcode-3.png)

Lastly, you need to select all elements in the section form previous step.

### Android

Create new file in `android/app/src/main/res/xml` directory named `locales_config.xml`. and define supported languages:

```xml
<?xml version="1.0" encoding="utf-8"?>
<locale-config xmlns:android="http://schemas.android.com/apk/res/android">
  <locale android:name="en"/>
  <locale android:name="pl"/>
  <locale android:name="fr"/>
</locale-config>
```

Then, open `android/app/src/main/AndroidManifest.xml` and add following line to the Application tag:

```xml
<application
        android:name=".MainApplication"
        android:localeConfig="@xml/locales_config" <!-- this line -->
>
```

## Inspiration

This plugin is heavily inspired by [react-native-localization-settings](https://github.com/jakex7/react-native-localization-settings/) plugin.