{"id":13801679,"url":"https://github.com/apache/cordova-plugin-splashscreen","last_synced_at":"2025-05-14T17:05:57.538Z","repository":{"id":9085306,"uuid":"10860606","full_name":"apache/cordova-plugin-splashscreen","owner":"apache","description":"Apache Cordova Plugin splashscreen","archived":false,"fork":false,"pushed_at":"2023-09-13T22:51:05.000Z","size":689,"stargazers_count":644,"open_issues_count":9,"forks_count":637,"subscribers_count":61,"default_branch":"master","last_synced_at":"2025-04-30T08:10:04.994Z","etag":null,"topics":["cordova","cplusplus","csharp","java","javascript","library","mobile","nodejs","objective-c"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"osmocom/rtl-sdr","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-06-22T07:00:18.000Z","updated_at":"2025-03-27T23:50:43.000Z","dependencies_parsed_at":"2024-04-27T09:42:09.079Z","dependency_job_id":null,"html_url":"https://github.com/apache/cordova-plugin-splashscreen","commit_stats":{"total_commits":381,"total_committers":87,"mean_commits":4.379310344827586,"dds":0.8425196850393701,"last_synced_commit":"586b988371fc57919288caacf7e1486ac44d19ca"},"previous_names":[],"tags_count":67,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fcordova-plugin-splashscreen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fcordova-plugin-splashscreen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fcordova-plugin-splashscreen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fcordova-plugin-splashscreen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/cordova-plugin-splashscreen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253266432,"owners_count":21880980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cordova","cplusplus","csharp","java","javascript","library","mobile","nodejs","objective-c"],"created_at":"2024-08-04T00:01:25.796Z","updated_at":"2025-05-14T17:05:57.518Z","avatar_url":"https://github.com/apache.png","language":"JavaScript","readme":"---\ntitle: Browser Splashscreen\ndescription: Control the browser platform splash screen for your app.\n---\n\u003c!--\n# license: Licensed to the Apache Software Foundation (ASF) under one\n#         or more contributor license agreements.  See the NOTICE file\n#         distributed with this work for additional information\n#         regarding copyright ownership.  The ASF licenses this file\n#         to you under the Apache License, Version 2.0 (the\n#         \"License\"); you may not use this file except in compliance\n#         with the License.  You may obtain a copy of the License at\n#\n#           http://www.apache.org/licenses/LICENSE-2.0\n#\n#         Unless required by applicable law or agreed to in writing,\n#         software distributed under the License is distributed on an\n#         \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n#         KIND, either express or implied.  See the License for the\n#         specific language governing permissions and limitations\n#         under the License.\n--\u003e\n\n# cordova-plugin-splashscreen\n\n[![Chrome Testsuite](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/chrome.yml/badge.svg)](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/chrome.yml) [![Lint Test](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/lint.yml/badge.svg)](https://github.com/apache/cordova-plugin-splashscreen/actions/workflows/lint.yml)\n\nThis plugin displays and hides a splash screen while your web application is launching. Using its methods you can also show and hide the splash screen manually.\n\n- [cordova-plugin-splashscreen](#cordova-plugin-splashscreen)\n  - [Installation](#installation)\n  - [Supported Platforms](#supported-platforms)\n  - [Platform Splash Screen Image Configuration](#platform-splash-screen-image-configuration)\n    - [Example Configuration](#example-configuration)\n  - [Preferences](#preferences)\n    - [config.xml](#configxml)\n    - [Quirks](#quirks)\n  - [Methods](#methods)\n    - [splashscreen.hide](#splashscreenhide)\n    - [splashscreen.show](#splashscreenshow)\n\n## Installation\n\n    // npm hosted (new) id\n    cordova plugin add cordova-plugin-splashscreen\n\n    // you may also install directly from this repo\n    cordova plugin add https://github.com/apache/cordova-plugin-splashscreen.git\n\n## Supported Platforms\n\n- Browser\n\n## Platform Splash Screen Image Configuration\n\n### Example Configuration\n\nIn the top-level `config.xml` file (not the one in `platforms`), add configuration elements like those specified here.\n\nThe value of the \"src\" attribute is relative to the project root directory and NOT to the `www` directory (see `Directory structure` below). You can name the source image file whatever you like. The internal name in the application is automatically determined by Cordova.\n\nDirectory structure:\n\n```\nprojectRoot\n    hooks\n    platforms\n    plugins\n    www\n        css\n        img\n        js\n    res\n        screen\n```\n\n```xml\n\u003cpreference name=\"SplashScreenDelay\" value=\"10000\" /\u003e\n```\n\n## Preferences\n\n### config.xml\n\n- `AutoHideSplashScreen` (boolean, default to `true`). Indicates whether to hide splash screen automatically or not. The splash screen is hidden after the amount of time specified in the `SplashScreenDelay` preference.\n\n    ```xml\n    \u003cpreference name=\"AutoHideSplashScreen\" value=\"true\" /\u003e\n    ```\n\n- `SplashScreenDelay` (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen.\n\n    ```xml\n    \u003cpreference name=\"SplashScreenDelay\" value=\"3000\" /\u003e\n    ```\n\n    This value used to be in seconds (but is now milliseconds) so values less than 30 will continue to be treated as seconds. (Consider this a deprecated patch that will disapear in some future version.)\n\n    To disable the splashscreen add the following preference to `config.xml`:\n    ```xml\n    \u003cpreference name=\"SplashScreenDelay\" value=\"0\"/\u003e\n    ```\n\n- `FadeSplashScreen` (boolean, defaults to `true`): Set to `false` to\n  prevent the splash screen from fading in and out when its display\n  state changes.\n\n    ```xml\n    \u003cpreference name=\"FadeSplashScreen\" value=\"false\"/\u003e\n    ```\n\n- `FadeSplashScreenDuration` (float, defaults to `500`): Specifies the\n  number of milliseconds for the splash screen fade effect to execute.\n\n    ```xml\n    \u003cpreference name=\"FadeSplashScreenDuration\" value=\"750\"/\u003e\n    ```\n\n    _Note_: `FadeSplashScreenDuration` is included into `SplashScreenDelay`, for example if you have `\u003cpreference name=\"SplashScreenDelay\" value=\"3000\" /\u003e` and `\u003cpreference name=\"FadeSplashScreenDuration\" value=\"1000\"/\u003e` defined in `config.xml`:\n\n    - 00:00 - splashscreen is shown\n    - 00:02 - fading has started\n    - 00:03 - splashscreen is hidden\n\n    Turning the fading off via `\u003cpreference name=\"FadeSplashScreen\" value=\"false\"/\u003e` technically means fading duration to be `0` so that in this example the overall splash screen delay will still be 3 seconds.\n\n    _Note_: This only applies to the application startup - you need to take the fading timeout into account when manually showing/hiding the splash screen in your application's code:\n\n    ```javascript\n    navigator.splashscreen.show();\n    window.setTimeout(function () {\n        navigator.splashscreen.hide();\n    }, splashDuration - fadeDuration);\n    ```\n\n### Quirks\n\nYou can use the following preferences in your `config.xml`:\n\n```xml\n\u003cplatform name=\"browser\"\u003e\n    \u003cpreference name=\"SplashScreen\" value=\"/images/browser/splashscreen.jpg\" /\u003e \u003c!-- defaults to \"/img/logo.png\" --\u003e\n    \u003cpreference name=\"AutoHideSplashScreen\" value=\"true\" /\u003e \u003c!-- defaults to \"true\" --\u003e\n    \u003cpreference name=\"SplashScreenDelay\" value=\"3000\" /\u003e \u003c!-- defaults to \"3000\" --\u003e\n    \u003cpreference name=\"SplashScreenBackgroundColor\" value=\"green\" /\u003e \u003c!-- defaults to \"#464646\" --\u003e\n    \u003cpreference name=\"ShowSplashScreen\" value=\"false\" /\u003e \u003c!-- defaults to \"true\" --\u003e\n    \u003cpreference name=\"SplashScreenWidth\" value=\"600\" /\u003e \u003c!-- defaults to \"170\" --\u003e\n    \u003cpreference name=\"SplashScreenHeight\" value=\"300\" /\u003e \u003c!-- defaults to \"200\" --\u003e\n\u003c/platform\u003e\n```\n\n__Note__: `SplashScreen` value should be absolute in order to work in a sub-page.\n\n## Methods\n\n- splashscreen.show\n- splashscreen.hide\n\n### splashscreen.hide\n\nDismiss the splash screen.\n\n```js\nnavigator.splashscreen.hide();\n```\n\n### splashscreen.show\n\nDisplays the splash screen.\n\n```js\nnavigator.splashscreen.show();\n```\n\nYour application cannot call `navigator.splashscreen.show()` until the application has\nstarted and the `deviceready` event has fired. But since typically the splash\nscreen is meant to be visible before your application has started, that would seem to\ndefeat the purpose of the splash screen.  Providing any parameters in\n`config.xml` will automatically `show` the splash screen immediately after your\napplication is launched and before it has fully started and received the `deviceready`\nevent. For this reason, it is unlikely you will need to call `navigator.splashscreen.show()` to make the splash\nscreen visible for application startup.\n","funding_links":[],"categories":["Index","Cordova plugins"],"sub_categories":["Incompatible"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fcordova-plugin-splashscreen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fcordova-plugin-splashscreen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fcordova-plugin-splashscreen/lists"}