{"_id":"@cordova-ohos/cordova-plugin-customconfigparameters","_rev":"5-c2a87ba7fa1070127a84c5f3fe8fa120","name":"@cordova-ohos/cordova-plugin-customconfigparameters","dist-tags":{"latest":"3.0.1"},"versions":{"3.0.0":{"name":"@cordova-ohos/cordova-plugin-customconfigparameters","version":"3.0.0","keywords":["cordova","customconfigparameters","ecosystem:cordova","cordova-openharmony"],"author":{"name":"Huawei Device, Inc. Ltd. and","email":"马弓手"},"license":"Apache-2.0","_id":"@cordova-ohos/cordova-plugin-customconfigparameters@3.0.0","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"bugs":{"url":"https://gitcode.com/OpenHarmony-Cordova/cordova-plugin-customconfigparameters/issues"},"dist":{"shasum":"b38592cb5ce8ee767cd5a5ea4b63d027e00cb552","tarball":"https://registry.npmjs.org/@cordova-ohos/cordova-plugin-customconfigparameters/-/cordova-plugin-customconfigparameters-3.0.0.tgz","fileCount":8,"integrity":"sha512-XrGhcBzdfZ4fLIaX6wY1/UiYjishOaJuVgBl9R2VTMG4T0S5HA3MO9dqPCivuj8s1pukg/cvKhpEXDFAZQQO1Q==","signatures":[{"sig":"MEQCIGjfX9da4N3IXgtyXn6GxMERV9IKZ/ynXLm7ij2NvfI+AiAcab/4q3hKIM1csLCRYMN30z7fyTTvFUP3ZdD13mR0Wg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":27010},"cordova":{"id":"cordova-plugin-customconfigparameters","platforms":["ohos"]},"engines":{"cordovaDependencies":{"3.0.0":{"hcordova":">=1.0.0","@cordova-ohos/ohos":">=2.0.0"}}},"gitHead":"7539b8592054802c2e148ddc088b871b2e51cbc8","_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"repository":{"url":"gitcode:OpenHarmony-Cordova/cordova-plugin-customconfigparameters","type":"git"},"_npmVersion":"10.5.1","description":"Cordova Customconfigparameters Plugin","directories":{},"_nodeVersion":"22.0.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/cordova-plugin-customconfigparameters_3.0.0_1773968850030_0.6049057170564756","host":"s3://npm-registry-packages-npm-production"}},"3.0.1":{"name":"@cordova-ohos/cordova-plugin-customconfigparameters","version":"3.0.1","description":"Cordova Customconfigparameters Plugin","cordova":{"id":"cordova-plugin-customconfigparameters","platforms":["ohos"]},"repository":{"type":"git","url":"gitcode:CPF-Cordova/cordova-plugin-customconfigparameters"},"bugs":{"url":"https://gitcode.com/CPF-Cordova/cordova-plugin-customconfigparameters/issues"},"keywords":["cordova","customconfigparameters","ecosystem:cordova","cordova-openharmony"],"engines":{"cordovaDependencies":{"3.0.1":{"@cordova-ohos/ohos":">=2.0.0","hcordova":">=1.0.0"}}},"author":{"name":"Huawei Device, Inc. Ltd. and","email":"马弓手"},"license":"Apache-2.0","_id":"@cordova-ohos/cordova-plugin-customconfigparameters@3.0.1","gitHead":"f2c9feb3765969358094dd53a6dcad4ac7db96f2","_nodeVersion":"22.0.0","_npmVersion":"10.5.1","dist":{"integrity":"sha512-ZZyky8zC6DG7KCDP4CBY4FwRXqHZGPgZNnFQxP8VxGuj6pj6shaicr1IW2gWIyuhZlckFHLOezODmGcxWN9YVQ==","shasum":"b2d50390c82e75e9d3801dc9d843acac6cb13119","tarball":"https://registry.npmjs.org/@cordova-ohos/cordova-plugin-customconfigparameters/-/cordova-plugin-customconfigparameters-3.0.1.tgz","fileCount":9,"unpackedSize":40880,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCICzpNiikq8jJ27LtGvS2WSJ9/ZT3Ne9kfRLobDlMESgEAiAgia2+RRIapyDPxZ14podKwLtPbQa6kZRnWykRrQ9sQA=="}]},"_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"directories":{},"maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"},{"name":"wanpengsz","email":"wanpengsz@163.com"},{"name":"xkh111","email":"xukaihui11@163.com"},{"name":"hcordova","email":"chenlihuiabc@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cordova-plugin-customconfigparameters_3.0.1_1785161671367_0.48107993558112505"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-20T01:07:29.964Z","modified":"2026-07-27T14:14:31.763Z","3.0.0":"2026-03-20T01:07:30.178Z","3.0.1":"2026-07-27T14:14:31.536Z"},"bugs":{"url":"https://gitcode.com/CPF-Cordova/cordova-plugin-customconfigparameters/issues"},"author":{"name":"Huawei Device, Inc. Ltd. and","email":"马弓手"},"license":"Apache-2.0","keywords":["cordova","customconfigparameters","ecosystem:cordova","cordova-openharmony"],"repository":{"type":"git","url":"gitcode:CPF-Cordova/cordova-plugin-customconfigparameters"},"description":"Cordova Customconfigparameters Plugin","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"},{"name":"wanpengsz","email":"wanpengsz@163.com"},{"name":"xkh111","email":"xukaihui11@163.com"},{"name":"hcordova","email":"chenlihuiabc@163.com"}],"readme":"# <center>cordova-plugin-customconfigparameters</center>\r\n\r\n[![zh-CN](https://img.shields.io/badge/lang-中文-blue.svg)](README.md)\r\n[![en](https://img.shields.io/badge/lang-English-blue.svg)](README.en.md)\r\n\r\n本项目基于 [cordova-plugin-customconfigparameters@3.0.0](https://www.npmjs.com/package/cordova-plugin-customconfigparameters/v/3.0.0) 开发，本文档重点阐述其在 OpenHarmony（OHOS）系统中的具体应用。\r\n\r\n- [cordova-plugin-customconfigparameters](#cordova-plugin-customconfigparameters)\r\n  - [简介](#简介)\r\n  - [支持平台](#支持平台)\r\n  - [下载安装](#下载安装)\r\n    - [从 npm 安装（推荐）](#从-npm-安装推荐)\r\n    - [从 GitCode 仓库安装（开发版）](#从-gitcode-仓库安装开发版)\r\n    - [离线安装（本地包）](#离线安装本地包)\r\n    - [安装后验证](#安装后验证)\r\n    - [卸载](#卸载)\r\n  - [约束与限制](#约束与限制)\r\n    - [兼容性](#兼容性)\r\n  - [使用示例](#使用示例)\r\n  - [使用说明](#使用说明)\r\n    - [API 参考](#api-参考)\r\n    - [读取配置参数（get）](#读取配置参数get)\r\n      - [参数说明](#参数说明)\r\n      - [使用示例](#使用示例-1)\r\n      - [返回数据格式](#返回数据格式)\r\n  - [目录结构](#目录结构)\r\n  - [贡献代码](#贡献代码)\r\n  - [许可证](#许可证)\r\n  - [官方资源](#官方资源)\r\n\r\n\r\n## 简介\r\n\r\n`cordova-plugin-customconfigparameters` 是 Harmony Cordova 生态系统中一款核心插件，一款专为 Cordova 混合移动应用打造的自定义配置参数管理插件，支持在应用运行时动态读取自定义配置参数。\r\n- 双源配置支持：支持从 config.xml 静态读取预设配置\r\n  \r\n- 多类型参数兼容：支持字符串、数字、布尔值、数组、对象等多种数据类型的配置参数，适配复杂业务场景\r\n\r\n## 支持平台\r\n\r\n- **Android**：API 19 及以上（Android 4.4+）\r\n\r\n- **iOS**：10.0 及以上\r\n\r\n- **OHOS**：5.0+\r\n\r\n## 下载安装\r\n\r\n确保已创建 Cordova 项目（若未创建，执行 `hcordova create configApp com.example.configapp ConfigApp` 创建），进入项目根目录后，通过 hcordova CLI 即可快速安装插件，支持从 npm 仓库、GitCode 仓库获取，可指定平台和版本安装。\r\n\r\n### 从 npm 安装（推荐）\r\n\r\n```bash\r\n# 使用 hcordova CLI 安装\r\n# 安装 hcordova 命令化工具\r\nnpm install -g hcordova\r\n\r\n# 全平台安装最新稳定版插件\r\nhcordova plugin add cordova-plugin-customconfigparameters\r\n\r\n# 仅安装到 OHOS 平台\r\nhcordova plugin add cordova-plugin-customconfigparameters --platform ohos\r\n\r\n# 安装指定版本（示例：1.0.0 版本）\r\nhcordova plugin add cordova-plugin-customconfigparameters@1.0.0 --platform ohos\r\n\r\n```\r\n\r\n### 从 GitCode 仓库安装（开发版）\r\n\r\n适用于需要体验最新功能的开发者，从 GitCode 仓库直接安装，仅为 OHOS 平台安装：\r\n\r\n```bash\r\n# 仅安装到 OHOS 平台，安装开发版插件\r\nhcordova plugin add https://gitcode.com/CPF-Cordova/cordova-plugin-customconfigparameters.git --platform ohos\r\n\r\n# 指定标签/分支安装\r\nhcordova plugin add https://gitcode.com/CPF-Cordova/cordova-plugin-customconfigparameters.git@develop --platform ohos\r\n\r\n```\r\n\r\n### 离线安装（本地包）\r\n\r\n适用于无网络环境，先下载插件包到本地，再执行离线安装：\r\n\r\n```bash\r\n# 下载插件包到本地（示例路径：~/Downloads/cordova-plugin-customconfigparameters）\r\n# 执行离线安装\r\nhcordova plugin add ~/Downloads/cordova-plugin-customconfigparameters --platform ohos\r\n```\r\n\r\n### 安装后验证\r\n\r\n安装完成后，可通过以下命令验证插件是否成功添加到项目中：\r\n\r\n```bash\r\n# 查看已安装的插件列表，若包含本插件 ID 则表示插件已成功安装\r\nhcordova plugin list\r\n```\r\n\r\n\r\n### 卸载\r\n\r\n进入项目根目录，执行以下命令卸载插件，卸载后建议重新构建项目以清理残留的原生配置文件和存储数据：\r\n\r\n```bash\r\n# Cordova CLI 全平台卸载\r\nhcordova plugin remove cordova-plugin-customconfigparameters \r\n\r\n# 指定平台卸载\r\nhcordova plugin remove cordova-plugin-customconfigparameters --platform ohos\r\n\r\n```\r\n\r\n## 约束与限制\r\n\r\n* 依赖插件：无强制依赖，插件集成后可直接使用，无需额外配置\r\n\r\n* 配置参数读取需确保 config.xml 中已预设对应静态配置（若使用静态配置），否则可能返回空值\r\n\r\n### 兼容性\r\n\r\n支持：\r\n\r\n| 项目 | 版本/信息 |\r\n|-----|--------|\r\n| SDK | API12+ |\r\n| IDE | DevEco Studio: 5.0+ |\r\n| ROM | 5.1+ |\r\n| Emulator | OpenHarmony 6.0+ |\r\n\r\n在以下版本中已测试通过：\r\n\r\n| 项目 | 版本/信息 |\r\n|-----|--------|\r\n| @cordova-ohos/ohos | 14.0.1-ohos-14.0.1 |\r\n| SDK | 5.0.0(12) |\r\n| IDE | DevEco Studio: 6.0.13.200 |\r\n| ROM | 5.1.0.120 SP3 |\r\n| Emulator | OpenHarmony 6.0.1(21) |\r\n\r\n## 使用示例\r\n\r\n```js\r\nvar paramkeyArray=[\"StatusBarStyle\",\"NavigationBarFontColor\",\"NavigationBarFontAlign\"];\r\nCustomConfigParameters.get(function(configData){\r\n    document.getElementById(\"getConfigParameters\").innerHTML = JSON.stringify(configData);\r\n},function(err){\r\n    console.log(err);\r\n},paramkeyArray);\r\n\r\n```\r\n\r\n返回数据格式示例：\r\n\r\n```json\r\n{\r\n  \"key\":\"value\"\r\n}\r\n\r\n```\r\n\r\n## 使用说明\r\n\r\n### API 参考\r\n\r\n插件核心功能挂载在 `CustomConfigParameters` 对象上，核心 API 为 get 方法，用于读取配置参数，支持读取静态配置和动态配置，适配多种数据类型。\r\n\r\n### 读取配置参数（get）\r\n\r\n用于读取指定 key 的配置参数，可传入多个 key 组成的数组，批量获取配置数据。\r\n\r\nAPI 格式：CustomConfigParameters.get(successCallback, errorCallback, paramkeyArray);\r\n\r\n#### 参数说明\r\n\r\n- successCallback：读取成功的回调函数，接收配置数据对象（JSON 格式）\r\n\r\n- errorCallback：读取失败的回调函数，接收错误信息\r\n\r\n- paramkeyArray：需要读取的配置参数 key 组成的数组（必填）\r\n\r\n#### 使用示例\r\n\r\n```js\r\nvar paramkeyArray=[\"StatusBarStyle\",\"NavigationBarFontColor\",\"NavigationBarFontAlign\"];\r\nCustomConfigParameters.get(function(configData){\r\n    document.getElementById(\"getConfigParameters\").innerHTML = JSON.stringify(configData);\r\n},function(err){\r\n    console.log(err);\r\n},paramkeyArray);\r\n\r\n```\r\n\r\n#### 返回数据格式\r\n\r\n```json\r\n{\r\n  \"key\":\"value\"\r\n}\r\n\r\n```\r\n\r\n## 目录结构\r\n\r\n```\r\ncordova-plugin-customconfigparameters/\r\n├── src/                          # 源代码目录\r\n│   └── main/                     # 主要源代码\r\n│       └── cpp/                  # C++ 原生代码\r\n│           └── Device/           # 设备模块\r\n│               ├── CustomConfigParameters.cpp  # 自定义配置参数功能的 C++ 实现\r\n│               └── CustomConfigParameters.h    # 自定义配置参数功能的头文件\r\n├── www/                          # Web 资源目录\r\n│   └── js customconfigparameters.js  # JavaScript 自定义配置参数接口（Cordova 桥接层）\r\n├── .gitignore                    # Git 忽略文件配置\r\n├── LICENSE                       # 项目开源许可证\r\n├── OAT.xml                       # OpenHarmony 审核配置文件\r\n├── package.json                  # Node.js 包配置\r\n├── plugin.xml                    # Cordova 插件描述文件（核心配置）\r\n└── README.md                     # 项目说明文档\r\n```\r\n\r\n## 贡献代码\r\n\r\n使用过程中发现任何问题都可以提 [Issue](https://gitcode.com/CPF-Cordova/cordova-plugin-customconfigparameters/issues) ，当然也非常欢迎发 [PR](https://gitcode.com/CPF-Cordova/cordova-plugin-customconfigparameters/pulls) 共建。\r\n\r\n## 许可证\r\n\r\n本插件基于 **Apache License 2.0** 开源，详见 [LICENSE](LICENSE) 文件。\r\n\r\n## 官方资源\r\n\r\n- OHOS Cordova: [https://gitcode.com/CPF-Cordova/cordova-plugin-customconfigparameters](https://gitcode.com/CPF-Cordova/cordova-plugin-customconfigparameters)\r\n\r\n- Android/iOS: [https://npmjs.com/cordova-plugin-customconfigparameters/issues](https://npmjs.com/cordova-plugin-customconfigparameters/issues)\r\n","readmeFilename":"README.md"}