@ordernow/capacitor-language 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MinhVDV
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/OrdernowCapacitorLanguage.podspec

@@ -0,0 +1,18 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'OrdernowCapacitorLanguage'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  # Capacitor 6 apps target iOS 13; 7 → 14, 8 → 15 (higher app targets are fine).
+  s.ios.deployment_target = '13.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/Package.swift

@@ -0,0 +1,24 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "OrdernowCapacitorLanguage",
+    platforms: [.iOS(.v13)],
+    products: [
+        .library(
+            name: "OrdernowCapacitorLanguage",
+            targets: ["AppLanguagePlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", "6.0.0"..<"9.0.0")
+    ],
+    targets: [
+        .target(
+            name: "AppLanguagePlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/AppLanguagePlugin")
+    ]
+)

package/README.md

@@ -1,3 +1,85 @@
-# Temporary Holding Version
+# @ordernow/capacitor-language
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Set the iOS per-app language (Settings → App → Language) from Capacitor apps
+
+## Why this plugin
+
+- **One language for web and system UI.** When the user picks a language inside your app, iOS system UI (alerts, share sheets, `PKAddPassButton`, the Wallet add sheet…) follows it too.
+- **Same setting as iOS Settings.** It writes the app's `AppleLanguages`, the value shown in Settings → App → Language, so both places stay in sync.
+- **No native code in your app.** No custom plugin file or `CAPBridgeViewController` subclass to register it: install and call.
+- **No extra dependencies.** Only `@capacitor/core` as a peer dependency.
+
+## Compatibility
+
+| Capacitor | iOS |
+| --- | --- |
+| 6.x | 13+ |
+| 7.x | 14+ |
+| 8.x | 15+ |
+
+One source for all three (`peerDependencies: @capacitor/core >=6 <9`). Android is not implemented (calls reject as "not implemented"); the web implementation is a no-op.
+
+## Install
+
+```bash
+npm install @ordernow/capacitor-language
+npx cap sync
+```
+
+### iOS
+
+- List every language you support in `CFBundleLocalizations` (Info.plist). iOS only shows Settings → App → Language, and only applies a language, when it is listed there.
+- iOS reads the language at launch: the change shows in system UI from the next launch.
+
+## Usage
+
+```ts
+import { AppLanguage } from '@ordernow/capacitor-language';
+
+await AppLanguage.set({ code: 'vi' }); // or 'zh-Hans', 'en'…
+await AppLanguage.set({}); // follow the device language again
+```
+
+## API
+
+<docgen-index>
+
+* [`set(...)`](#set)
+* [Interfaces](#interfaces)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### set(...)
+
+```typescript
+set(options: SetLanguageOptions) => Promise<void>
+```
+
+iOS only (a no-op on the web). Sets the app's iOS language, the one shown in
+Settings → App → Language. iOS reads it at launch, so system UI follows it
+from the next launch.
+
+| Param         | Type                                                              |
+| ------------- | ----------------------------------------------------------------- |
+| **`options`** | <code><a href="#setlanguageoptions">SetLanguageOptions</a></code> |
+
+--------------------
+
+
+### Interfaces
+
+
+#### SetLanguageOptions
+
+| Prop       | Type                | Description                                                                                             |
+| ---------- | ------------------- | ------------------------------------------------------------------------------------------------------- |
+| **`code`** | <code>string</code> | iOS language identifier listed in `CFBundleLocalizations` ("vi", "zh-Hans"). Omit to follow the device. |
+
+</docgen-api>
+
+## Support
+
+Made by **MinhVDV**. If this plugin saves you time, you can support its development via [PayPal](https://paypal.me/MinhVDV).

package/dist/docs.json

@@ -0,0 +1,50 @@
+{
+  "api": {
+    "name": "AppLanguagePlugin",
+    "slug": "applanguageplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "set",
+        "signature": "(options: SetLanguageOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetLanguageOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "iOS only (a no-op on the web). Sets the app's iOS language, the one shown in\nSettings → App → Language. iOS reads it at launch, so system UI follows it\nfrom the next launch.",
+        "complexTypes": [
+          "SetLanguageOptions"
+        ],
+        "slug": "set"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "SetLanguageOptions",
+      "slug": "setlanguageoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "code",
+          "tags": [],
+          "docs": "iOS language identifier listed in `CFBundleLocalizations` (\"vi\", \"zh-Hans\"). Omit to follow the device.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,12 @@
+export interface SetLanguageOptions {
+    /** iOS language identifier listed in `CFBundleLocalizations` ("vi", "zh-Hans"). Omit to follow the device. */
+    code?: string;
+}
+export interface AppLanguagePlugin {
+    /**
+     * iOS only (a no-op on the web). Sets the app's iOS language, the one shown in
+     * Settings → App → Language. iOS reads it at launch, so system UI follows it
+     * from the next launch.
+     */
+    set(options: SetLanguageOptions): Promise<void>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.d.ts

@@ -0,0 +1,3 @@
+import type { AppLanguagePlugin } from './definitions.js';
+export * from './definitions.js';
+export declare const AppLanguage: AppLanguagePlugin;

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+import { registerPlugin } from '@capacitor/core';
+export * from './definitions.js';
+export const AppLanguage = registerPlugin('AppLanguage', {
+    web: () => import('./web.js').then((m) => new m.AppLanguageWeb()),
+});

package/dist/esm/web.d.ts

@@ -0,0 +1,5 @@
+import { WebPlugin } from '@capacitor/core';
+/** The web has no app-level language: nothing to set. */
+export declare class AppLanguageWeb extends WebPlugin {
+    set(): Promise<void>;
+}

package/dist/esm/web.js

@@ -0,0 +1,7 @@
+import { WebPlugin } from '@capacitor/core';
+/** The web has no app-level language: nothing to set. */
+export class AppLanguageWeb extends WebPlugin {
+    async set() {
+        return;
+    }
+}

package/dist/plugin.cjs.js

@@ -0,0 +1,21 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+const AppLanguage = core.registerPlugin('AppLanguage', {
+    web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.AppLanguageWeb()),
+});
+
+/** The web has no app-level language: nothing to set. */
+class AppLanguageWeb extends core.WebPlugin {
+    async set() {
+        return;
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    AppLanguageWeb: AppLanguageWeb
+});
+
+exports.AppLanguage = AppLanguage;

package/ios/Sources/AppLanguagePlugin/AppLanguagePlugin.swift

@@ -0,0 +1,25 @@
+import Capacitor
+import Foundation
+
+/// Writes the in-app language choice to the app's iOS language (Settings → App →
+/// Language). AppleLanguages is read at launch, so system UI such as
+/// PKAddPassButton follows it from the next launch.
+/// CAPBridgedPlugin registration works on Capacitor 6, 7 and 8.
+@objc(AppLanguagePlugin)
+public class AppLanguagePlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "AppLanguagePlugin"
+    public let jsName = "AppLanguage"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "set", returnType: CAPPluginReturnPromise)
+    ]
+
+    /// `code` is an iOS language identifier ("vi", "zh-Hans"); none = follow the device.
+    @objc func set(_ call: CAPPluginCall) {
+        if let code = call.getString("code") {
+            UserDefaults.standard.set([code], forKey: "AppleLanguages")
+        } else {
+            UserDefaults.standard.removeObject(forKey: "AppleLanguages")
+        }
+        call.resolve()
+    }
+}

package/package.json

@@ -1,6 +1,79 @@
 {
   "name": "@ordernow/capacitor-language",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Set the iOS per-app language (Settings → App → Language) from Capacitor apps",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "files": [
+    "dist/",
+    "ios/Sources",
+    "Package.swift",
+    "OrdernowCapacitorLanguage.podspec",
+    "LICENSE"
+  ],
+  "author": "MinhVDV",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mark-ordernow/capacitor-language-setting.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mark-ordernow/capacitor-language-setting/issues"
+  },
+  "funding": {
+    "type": "paypal",
+    "url": "https://paypal.me/MinhVDV"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native",
+    "language",
+    "locale",
+    "i18n"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:web",
+    "verify:ios": "xcodebuild -scheme OrdernowCapacitorLanguage -destination generic/platform=iOS",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js}\"",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api AppLanguagePlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "@capacitor/core": "^7.4.4",
+    "@capacitor/docgen": "^0.3.1",
+    "@capacitor/ios": "^7.4.4",
+    "@ionic/eslint-config": "^0.4.0",
+    "@ionic/prettier-config": "^4.0.0",
+    "@ionic/swiftlint-config": "^2.0.0",
+    "eslint": "^8.57.1",
+    "prettier": "^3.6.2",
+    "rimraf": "^6.1.0",
+    "rollup": "^4.53.2",
+    "swiftlint": "^2.0.0",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=6.0.0 <9.0.0"
+  },
+  "prettier": "@ionic/prettier-config",
+  "swiftlint": "@ionic/swiftlint-config",
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    }
+  },
+  "homepage": "https://github.com/mark-ordernow/capacitor-language-setting#readme"
+}