You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

118 lines
6.0 KiB

8 years ago
  1. <!--
  2. # license: Licensed to the Apache Software Foundation (ASF) under one
  3. # or more contributor license agreements. See the NOTICE file
  4. # distributed with this work for additional information
  5. # regarding copyright ownership. The ASF licenses this file
  6. # to you under the Apache License, Version 2.0 (the
  7. # "License"); you may not use this file except in compliance
  8. # with the License. You may obtain a copy of the License at
  9. #
  10. # http://www.apache.org/licenses/LICENSE-2.0
  11. #
  12. # Unless required by applicable law or agreed to in writing,
  13. # software distributed under the License is distributed on an
  14. # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15. # KIND, either express or implied. See the License for the
  16. # specific language governing permissions and limitations
  17. # under the License.
  18. -->
  19. # cordova-plugin-splashscreen
  20. [![Build Status](https://travis-ci.org/apache/cordova-plugin-splashscreen.svg)](https://travis-ci.org/apache/cordova-plugin-splashscreen)
  21. Ce plugin affiche et masque un écran de démarrage lors du lancement de l'application.
  22. ## Installation
  23. // npm hosted (new) id
  24. cordova plugin add cordova-plugin-splashscreen
  25. // you may also install directly from this repo
  26. cordova plugin add https://github.com/apache/cordova-plugin-splashscreen.git
  27. ## Plates-formes supportées
  28. * Amazon Fire OS
  29. * Android
  30. * BlackBerry 10
  31. * iOS
  32. * Windows Phone 7 et 8
  33. * Windows 8
  34. * Windows
  35. * Navigateur
  36. ## Méthodes
  37. * splashscreen.Show
  38. * splashscreen.Hide
  39. ### Quirks Android
  40. Dans votre `fichier config.xml`, vous devez ajouter les préférences suivantes :
  41. <preference name="SplashScreen" value="foo" />
  42. <preference name="SplashScreenDelay" value="10000" />
  43. <preference name="SplashMaintainAspectRatio" value="true|false" />
  44. Où foo est le nom du fichier splashscreen, préférablement un fichier de 9 correctif. Assurez-vous d'ajouter vos fichiers splashcreen dans votre répertoire res/xml dans les dossiers appropriés. Le deuxième paramètre représente combien de temps le splashscreen apparaîtra en millisecondes. Il est par défaut à 3000 ms. Pour plus d'informations, consultez [icônes et écrans de démarrage](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html).
  45. Préférence de « SplashMaintainAspectRatio » est facultative. Si défini à true, écran de démarrage drawable n'est pas étirée pour s'adapter écran, mais plutôt simplement « couvre » l'écran, comme CSS "fond-taille : couverture". Ceci est très utile lorsque images écran de démarrage ne peut pas être déformées en quelque sorte, par exemple lorsqu'ils contiennent des décors ou texte. Ce paramètre fonctionne mieux avec des images qui ont des marges importantes (zones de sécurité) qui peuvent être recadrées en toute sécurité sur les écrans avec des proportions différentes.
  46. Le plugin recharge splash drawable chaque fois que l'orientation change, donc vous pouvez spécifier différents drawables pour les orientations portrait et paysage.
  47. ### Bizarreries navigateur
  48. Vous pouvez utiliser les préférences suivantes dans votre `fichier config.xml`:
  49. <platform name="browser">
  50. <preference name="SplashScreen" value="images/browser/splashscreen.jpg" /> <!-- defaults to "img/logo.png" -->
  51. <preference name="SplashScreenDelay" value="10000" /> <!-- defaults to "3000" -->
  52. <preference name="SplashScreenBackgroundColor" value="green" /> <!-- defaults to "#464646" -->
  53. <preference name="ShowSplashScreen" value="false" /> <!-- defaults to "true" -->
  54. <preference name="SplashScreenWidth" value="600" /> <!-- defaults to "170" -->
  55. <preference name="SplashScreenHeight" value="300" /> <!-- defaults to "200" -->
  56. </platform>
  57. ### Notes au sujet d'iOS
  58. * `FadeSplashScreen` (boolean, par défaut est `true`): la valeur `false` pour empêcher l'écran de démarrage de fading in et out lorsque son état d'affichage est modifié.
  59. <preference name="FadeSplashScreen" value="false"/>
  60. * `FadeSplashScreenDuration` (float, la valeur par défaut `2`): spécifie le nombre de secondes que l'écran de démarrage s'estomper l'effet d'exécuter.
  61. <preference name="FadeSplashScreenDuration" value="4"/>
  62. * `ShowSplashScreenSpinner` (boolean, par défaut est `true`): la valeur `false` pour masquer le cône de l'écran de démarrage.
  63. <preference name="ShowSplashScreenSpinner" value="false"/>
  64. ## splashscreen.Hide
  65. Faire disparaître de l'écran de démarrage.
  66. navigator.splashscreen.hide();
  67. ### BlackBerry 10, WP8, iOS Quirk
  68. Paramètre `AutoHideSplashScreen` du fichier `config.xml` doit avoir la valeur `false`. Pour retarder la cacher l'écran de démarrage pendant deux secondes, ajouter un minuteur semblable à la suivante dans le gestionnaire d'événements `deviceready` :
  69. setTimeout(function() {
  70. navigator.splashscreen.hide();
  71. }, 2000);
  72. ## splashscreen.Show
  73. Affiche l'écran de démarrage.
  74. navigator.splashscreen.show();
  75. Votre application ne peut pas appeler `navigator.splashscreen.show()` jusqu'à ce que l'application a commencé et l'événement `deviceready` est déclenché. Mais puisqu'en général, l'écran de démarrage est destiné à être visible avant que votre application a commencé, qui semblerait à l'encontre des objectifs de l'écran de démarrage. Fournir une configuration dans le fichier `config.xml` automatiquement `show` le splash projettera immédiatement après votre lancement de l'app et avant qu'il a complètement démarré et a reçu l'événement `deviceready`. Voir les [icônes et les écrans de démarrage](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html) pour plus d'informations sur la conduite de cette configuration. Pour cette raison, il est peu probable que vous devez appeler `navigator.splashscreen.show()` pour rendre l'écran de démarrage visible pour le démarrage de l'application.