{"_id":"@capacitor-ohos/splash-screen","_rev":"2-66522f3359ee6c1090b4925828fe3d6c","name":"@capacitor-ohos/splash-screen","dist-tags":{"latest":"8.0.2"},"versions":{"8.0.1":{"name":"@capacitor-ohos/splash-screen","version":"8.0.1","keywords":["capacitor","plugin","native"],"author":{"url":"Group","name":"Huawei Device Co., Ltd and iSoftStone Information Technology"},"license":"MIT","_id":"@capacitor-ohos/splash-screen@8.0.1","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"bugs":{"url":"https://gitcode.com/CPF-Ionic/capacitor-splash-screen/issues"},"dist":{"shasum":"91c6afbb94f563b35cf0ae3b81e9dea786a28751","tarball":"https://registry.npmjs.org/@capacitor-ohos/splash-screen/-/splash-screen-8.0.1.tgz","fileCount":9,"integrity":"sha512-kOabkIERLdLOV1MZuO7vZGO1s/NY25W+cF07R2T5ZVNo4WrUNGl/BdtT3Z8pJpr/2qnfjWHEpcyQIbhHibQT+w==","signatures":[{"sig":"MEUCICGMd6+4SU2N3IwAowUqtDaYR5fqa+RIszLoiOGvUupnAiEA4KNgGc+fhVuT80c4eUMcMql6WT2FSEv07Q5bI6XHOjk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":32655},"gitHead":"94b2c70ea170ed89033273b1dbb129cf5ef597d8","_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"capacitor":{"id":"@capacitor/splash-screen","platforms":["openharmony"]},"repository":{"url":"gitcode:CPF-Ionic/capacitor-splash-screen","type":"git"},"_npmVersion":"10.5.1","description":"The Splash Screen API provides methods for showing or hiding a Splash image.","directories":{},"_nodeVersion":"22.0.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/splash-screen_8.0.1_1777544507354_0.8120377303457196","host":"s3://npm-registry-packages-npm-production"}},"8.0.2":{"name":"@capacitor-ohos/splash-screen","version":"8.0.2","description":"The Splash Screen API provides methods for showing or hiding a Splash image.","capacitor":{"id":"@capacitor/splash-screen","platforms":["openharmony"]},"repository":{"type":"git","url":"gitcode:CPF-Ionic/capacitor-splash-screen"},"bugs":{"url":"https://gitcode.com/CPF-Ionic/capacitor-splash-screen/issues"},"keywords":["capacitor","plugin","native"],"author":{"name":"Huawei Device Co., Ltd and iSoftStone Information Technology","url":"Group"},"license":"MIT","_id":"@capacitor-ohos/splash-screen@8.0.2","gitHead":"c4b16ad88cf5d094a0519b1adf3da90b7542cb7a","_nodeVersion":"22.0.0","_npmVersion":"10.5.1","dist":{"integrity":"sha512-P4swfl5lh8CXVK1fOuUHgCJz7BV62VAibmHtws0OqTE7qabpvrF8gigccz3m8kcHTthfeB+a9bFYN773V2EN5w==","shasum":"03a7eb574b1e912dafb336d7ac5b3127cdb85c2b","tarball":"https://registry.npmjs.org/@capacitor-ohos/splash-screen/-/splash-screen-8.0.2.tgz","fileCount":9,"unpackedSize":32662,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDxYkDQILo87BlH59ugi9C/82JMtYx9IQUdEkOIYIuLJQIhAOzMHa/DBcxjHp3jAwPmtWsfsV7kQb7rgF7wJXt0CoCW"}]},"_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"directories":{},"maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/splash-screen_8.0.2_1784794429288_0.7239065838182066"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-30T10:21:47.219Z","modified":"2026-07-23T08:13:49.567Z","8.0.1":"2026-04-30T10:21:47.492Z","8.0.2":"2026-07-23T08:13:49.418Z"},"bugs":{"url":"https://gitcode.com/CPF-Ionic/capacitor-splash-screen/issues"},"author":{"name":"Huawei Device Co., Ltd and iSoftStone Information Technology","url":"Group"},"license":"MIT","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"gitcode:CPF-Ionic/capacitor-splash-screen"},"description":"The Splash Screen API provides methods for showing or hiding a Splash image.","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"readme":"# <center>@capacitor/splash-screen</center>\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本项目基于 [@capacitor/splash-screen@8.0.0](https://www.npmjs.com/package/@capacitor/splash-screen/v/8.0.0) 开发。\r\n\r\n## 简介\r\n\r\n@capacitor/splash-screen是capacitor生态系统中的核心插件，用于显示或隐藏启动画页面，为跨平台应用开发提供设备差异化适配能力，兼容capacitor的Android、iOS等主流移动平台及浏览器环境，本文档只说明在OpenHarmony系统中的使用。\r\n\r\n应用启动时，会加载OpenHarmony原生启动页配置，进行启动样式展示，建议使用原生默认[配置](https://docs.openharmony.cn/pages/v6.0/zh-cn/application-dev/windowmanager/launch-page-config.md)\r\n启动。\r\n\r\nAPI可实现启动画页面的显示或隐藏操作，适配OpenHarmony系统的启动页展示需求。\r\n\r\n## 支持平台\r\n\r\n- **OpenHarmony**：5.0+\r\n\r\n## 下载安装\r\n\r\n通过命令行或手动引入即可快速安装插件，支持从npm仓库获取。\r\n\r\n### 命令行安装（推荐）\r\n\r\n安装hionic CLI：\r\n\r\n```bash\r\nnpm install -g hionic\r\n```\r\n\r\n以下两种方式中**任选其一**即可，无需重复操作：\r\n\r\nnpm安装：\r\n\r\n```bash\r\n# 安装插件\r\nnpm install @capacitor/splash-screen\r\n\r\n# 同步插件\r\nhionic sync openharmony\r\n```\r\n\r\nhionic CLI安装：\r\n\r\n```bash\r\nhionic plugin add @capacitor/splash-screen\r\n```\r\n\r\n### 手动引入安装\r\n\r\n根据插件源码中 `plugin.xml` 配置在项目中引入插件：\r\n\r\n#### 1. 添加插件配置\r\n\r\n根据 `plugin.xml` 的 `config-json` 项，通过 `target` 字段找到 `entry` 模块中 `capacitor.plugins.json` 文件，并根据 `param`\r\n标签添加配置如下：\r\n\r\n```json\r\n{\r\n  \"pkg\": \"@capacitor/splash-screen\",\r\n  \"classpath\": \"SplashScreen\"\r\n}\r\n```\r\n\r\n#### 2. 修改 CMake 配置\r\n\r\n根据 `plugin.xml` 的 `CMakeLists` 项，通过 `modules-name` 字段找到模块 `capacitor`，路径为 `target` 字段的\r\n`CMakeLists.txt` 文件，并添加 `add_subdirectory` 和 `target_link_libraries` 如下：\r\n\r\n```cmake\r\n#START_ADD_SUBDIRECTORY\r\n// ...\r\nadd_subdirectory(SplashScreen)\r\n// ...\r\n#END_ADD_SUBDIRECTORY\r\n\r\n// ...\r\n\r\ntarget_link_libraries(capacitor PUBLIC\r\n  \"-Wl,--whole-archive\"\r\n  // ...\r\n  SplashScreen\r\n  // ...\r\n  \"-Wl,--no-whole-archive\"\r\n)\r\n```\r\n\r\n#### 3. 复制源码文件\r\n\r\n根据 `plugin.xml` 的 `source-file` 项，根据 `src` 字段找到需要复制的文件，并根据 `modules-name` 字段和 `target-dir`\r\n字段找到文件复制的具体模块和目录：\r\n\r\n将插件源码中src/main/cpp/Splashscreen目录下的SplashScreen.h、SplashScreen.cpp、CMakeLists.txt文件引入到capacitor模块中src/main/cpp/SplashScreen目录下\r\n\r\n## 卸载\r\n\r\n```bash\r\n# 卸载 splash-screen 插件\r\nhionic plugin remove @capacitor/splash-screen\r\n```\r\n\r\n## 约束与限制\r\n\r\n### 兼容性\r\n\r\n在以下版本中已测试通过：\r\n\r\n1. capacitor: 8.0.0-ohos-8.0.0; SDK: 5.0.5(17); IDE: DevEco Studio: 6.0.0; ROM: 5.1.0.150;\r\n\r\n### 资源图片配置\r\n\r\n资源图片名称为 `androidSplashResourceName`，需存放在 `resource/media` 目录下；若资源图片不存在，启动屏将显示设置的背景颜色或启动失败，需在\r\n`capacitor.config.json` 中配置该图片名称。\r\n\r\n## 配置\r\n\r\n以下为插件支持的配置项，可在 `capacitor.config.json` 中进行配置，适配启动屏展示效果：\r\n\r\n| 配置项                       | 类型                                                                                                   | 描述                                      |\r\n|---------------------------|------------------------------------------------------------------------------------------------------|-----------------------------------------|\r\n| launchShowDuration        | number                                                                                               | 当自动隐藏启用时，启动画面显示的时长（单位：毫秒）               |\r\n| launchAutoHide            | boolean                                                                                              | 应用启动后，启动画面是否自动隐藏                        |\r\n| launchFadeOutDuration     | number                                                                                               | 启动画面淡出动画的时长（单位：毫秒）                      |\r\n| backgroundColor           | string                                                                                               | 启动画面背景颜色（十六进制格式），支持 #RRGGBB 或 #RRGGBBAA |\r\n| androidSplashResourceName | string                                                                                               | 作为启动画面的资源图片名称，需存放在 resource/media 目录下   |\r\n| androidScaleType          | 'CENTER' \\| 'CENTER_CROP' \\| 'CENTER_INSIDE' \\| 'FIT_CENTER' \\| 'FIT_END' \\| 'FIT_START' \\| 'FIT_XY' | 启动画面图片的缩放方式                             |\r\n| showSpinner               | boolean                                                                                              | 是否在启动画面上显示加载旋转器                         |\r\n| androidSpinnerStyle       | 'horizontal' \\| 'small' \\| 'large' \\| 'inverse' \\| 'smallInverse' \\| 'largeInverse'                  | Android平台上旋转器的样式                        |\r\n| iosSpinnerStyle           | 'small'\\| 'large'                                                                                    | iOS平台上旋转器的样式（本文档仅说明OpenHarmony使用，供参考）   |\r\n| spinnerColor              | string                                                                                               | 旋转器颜色（十六进制格式），支持 #RRGGBB 或 #RRGGBBAA    |\r\n| splashFullScreen          | boolean                                                                                              | 是否隐藏启动画面上的状态栏                           |\r\n| splashImmersive           | boolean                                                                                              | 是否隐藏启动画面上的状态栏和软件导航按钮                    |\r\n| layoutName                | string                                                                                               | 暂不支持                                    |\r\n| useDialog                 | boolean                                                                                              | 暂不支持                                    |\r\n\r\n### 配置示例\r\n\r\n配置文件路径：`capacitor.config.json`\r\n\r\n```json\r\n{\r\n  \"plugins\": {\r\n    \"SplashScreen\": {\r\n      \"launchShowDuration\": 2000,\r\n      \"launchAutoHide\": true,\r\n      \"launchFadeOutDuration\": 200,\r\n      \"backgroundColor\": \"#ffffffff\",\r\n      \"androidSplashResourceName\": \"splash\",\r\n      \"androidScaleType\": \"CENTER\",\r\n      \"showSpinner\": true,\r\n      \"androidSpinnerStyle\": \"large\",\r\n      \"iosSpinnerStyle\": \"large\",\r\n      \"spinnerColor\": \"#f1a71dff\",\r\n      \"splashFullScreen\": true,\r\n      \"splashImmersive\": true\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n## 使用示例\r\n\r\n### 示例1：显示和隐藏启动屏\r\n\r\n```typescript\r\nimport { SplashScreen } from '@capacitor/splash-screen';\r\n\r\n// 隐藏启动屏（建议在应用启动时执行）\r\nawait SplashScreen.hide();\r\n\r\n// 显示启动屏，无限期显示（不自动隐藏）\r\nawait SplashScreen.show({\r\n  autoHide: false,\r\n});\r\n\r\n// 显示启动屏，持续2秒后自动隐藏\r\nawait SplashScreen.show({\r\n  showDuration: 2000,\r\n  autoHide: true,\r\n});\r\n```\r\n\r\n## 使用说明\r\n\r\nSplashScreen是插件导出对象，可直接导入使用，导入后即可调用插件提供的所有方法，调用便捷高效，所有API均基于Promise实现，支持异步调用，适用于应用启动时的启动屏控制场景。\r\n\r\n## 核心 API\r\n\r\n### 接口方法\r\n\r\n| 方法名       | 请求参数                                               | 返回类型                | 描述      |\r\n|-----------|----------------------------------------------------|---------------------|---------|\r\n| show(...) | options?: [ShowOptions](#showoptions) \\| undefined | Promise&lt;void&gt; | 显示启动画页面 |\r\n| hide(...) | options?: [HideOptions](#hideoptions) \\| undefined | Promise&lt;void&gt; | 隐藏启动画页面 |\r\n\r\n### 数据结构\r\n\r\n#### ShowOptions\r\n\r\n调用 show 方法时的入参对象，用于配置启动屏显示相关参数。\r\n\r\n| 数据              | 类型      | 描述                    |\r\n|-----------------|---------|-----------------------|\r\n| autoHide        | boolean | 启动屏显示后是否自动隐藏          |\r\n| fadeInDuration  | number  | 启动屏淡入时间（单位：毫秒）        |\r\n| fadeOutDuration | number  | 启动屏淡出时间（单位：毫秒）        |\r\n| showDuration    | number  | 启动屏从显示到开始隐藏的时间（单位：毫秒） |\r\n\r\n#### HideOptions\r\n\r\n调用 hide 方法时的入参对象，用于配置启动屏隐藏相关参数。\r\n\r\n| 数据              | 类型     | 描述             |\r\n|-----------------|--------|----------------|\r\n| fadeOutDuration | number | 启动屏淡出时间（单位：毫秒） |\r\n\r\n## 目录结构\r\n\r\n```plaintext\r\n|---- 目录\r\n|     |---- src/main  # 插件的实现代码\r\n|           |----cpp  # C++ 代码\r\n|     |---- README.md          # 说明文档\r\n|     |---- package.json       # 配置文件\r\n|     |---- plugin.xml         # 插件配置文件\r\n```\r\n\r\n## 贡献代码\r\n\r\n使用过程中发现任何问题都可以提 [Issue](https://gitcode.com/CPF-Ionic/capacitor-splash-screen/issues)\r\n，当然，也非常欢迎发[PR](https://gitcode.com/CPF-Ionic/capacitor-splash-screen/pulls) 共建。\r\n\r\n## 许可证\r\n\r\n本插件基于 **MIT License** 开源，详见 [LICENSE](./LICENSE) 文件。\r\n","readmeFilename":"README.md"}