README.md 8.9 KB
Newer Older
李晓兵's avatar
李晓兵 committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
<!--
# license: Licensed to the Apache Software Foundation (ASF) under one
#         or more contributor license agreements.  See the NOTICE file
#         distributed with this work for additional information
#         regarding copyright ownership.  The ASF licenses this file
#         to you under the Apache License, Version 2.0 (the
#         "License"); you may not use this file except in compliance
#         with the License.  You may obtain a copy of the License at
#
#           http://www.apache.org/licenses/LICENSE-2.0
#
#         Unless required by applicable law or agreed to in writing,
#         software distributed under the License is distributed on an
#         "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#         KIND, either express or implied.  See the License for the
#         specific language governing permissions and limitations
#         under the License.
-->

# cordova-plugin-dialogs

[![Build Status](https://travis-ci.org/apache/cordova-plugin-dialogs.svg)](https://travis-ci.org/apache/cordova-plugin-dialogs)

Ce plugin permet d'accéder à certains éléments d'interface utilisateur native de dialogue via un global `navigator.notification` objet.

Bien que l'objet est attaché à la portée globale `navigator` , il n'est pas disponible jusqu'après la `deviceready` événement.

    document.addEventListener (« deviceready », onDeviceReady, false) ;
    function onDeviceReady() {console.log(navigator.notification);}
    

## Installation

    cordova plugin add cordova-plugin-dialogs
    

## Méthodes

  * `navigator.notification.alert`
  * `navigator.notification.confirm`
  * `navigator.notification.prompt`
  * `navigator.notification.beep`

## navigator.notification.alert

Affiche une boîte de dialogue ou d'alerte personnalisé. La plupart des implémentations de Cordova utilisent une boîte de dialogue natives pour cette fonctionnalité, mais certaines plates-formes du navigateur `alert` fonction, qui est généralement moins personnalisable.

    Navigator.notification.Alert (message, alertCallback, [title], [buttonName])
    

  * **message**: message de la boîte de dialogue. *(String)*

  * **alertCallback**: callback à appeler lorsque la boîte de dialogue d'alerte est rejetée. *(Fonction)*

  * **titre**: titre de la boîte de dialogue. *(String)* (Facultatif, par défaut`Alert`)

  * **buttonName**: nom du bouton. *(String)* (Facultatif, par défaut`OK`)

### Exemple

    function alertDismissed() {/ / faire quelque chose} navigator.notification.alert ('Vous êtes le gagnant!', / / message alertDismissed, / / rappel « Game Over », / / titre « Done » / / buttonName) ;
    

### Plates-formes supportées

  * Amazon Fire OS
  * Android
  * BlackBerry 10
  * Firefox OS
  * iOS
  * Paciarelli
  * Windows Phone 7 et 8
  * Windows 8
  * Windows

### Notes au sujet de Windows Phone 7 et 8

  * Il n'y a aucune boîte de dialogue d'alerte intégrée au navigateur, mais vous pouvez en lier une pour appeler `alert()` dans le scope global:
    
        window.alert = navigator.notification.alert;
        

  * Les deux appels `alert` et `confirm` sont non-blocants, leurs résultats ne sont disponibles que de façon asynchrone.

### Firefox OS Quirks :

Les deux indigènes bloquant `window.alert()` et non-bloquante `navigator.notification.alert()` sont disponibles.

### BlackBerry 10 Quirks

`navigator.notification.alert('text', callback, 'title', 'text')`paramètre callback est passé numéro 1.

## navigator.notification.confirm

Affiche une boîte de dialogue de confirmation personnalisable.

    Navigator.notification.Confirm (message, confirmCallback, [title], [buttonLabels])
    

  * **message**: message de la boîte de dialogue. *(String)*

  * **confirmCallback**: callback à appeler avec l'index du bouton pressé (1, 2 ou 3) ou lorsque la boîte de dialogue est fermée sans qu'un bouton ne soit pressé (0). *(Fonction)*

  * **titre**: titre de dialogue. *(String)* (Facultatif, par défaut`Confirm`)

  * **buttonLabels**: tableau de chaînes spécifiant les étiquettes des boutons. *(Array)* (Optionnel, par défaut, [ `OK,Cancel` ])

### confirmCallback

Le `confirmCallback` s'exécute lorsque l'utilisateur appuie sur un bouton dans la boîte de dialogue de confirmation.

Le rappel prend l'argument `buttonIndex` *(nombre)*, qui est l'index du bouton activé. Notez que l'index utilise base d'indexation, la valeur est `1` , `2` , `3` , etc..

### Exemple

    function onConfirm(buttonIndex) {alert (« Vous bouton sélectionné » + buttonIndex);}
    
    Navigator.notification.Confirm ('Vous êtes le gagnant!', / / message onConfirm, / / rappel d'invoquer avec l'index du bouton enfoncé « Game Over », / / title ['redémarrer', « Exit »] / / buttonLabels) ;
    

### Plates-formes supportées

  * Amazon Fire OS
  * Android
  * BlackBerry 10
  * Firefox OS
  * iOS
  * Paciarelli
  * Windows Phone 7 et 8
  * Windows 8
  * Windows

### Notes au sujet de Windows Phone 7 et 8

  * Il n'y a aucune fonction intégrée au navigateur pour `window.confirm`, mais vous pouvez en lier une en affectant:
    
        window.confirm = navigator.notification.confirm ;
        

  * Les appels à `alert` et `confirm` sont non-bloquants, donc le résultat est seulement disponible de façon asynchrone.

### Bizarreries de Windows

  * Sur Windows8/8.1, il n'est pas possible d'ajouter plus de trois boutons à MessageDialog instance.

  * Sur Windows Phone 8.1, il n'est pas possible d'établir le dialogue avec plus de deux boutons.

### Firefox OS Quirks :

Les deux indigènes bloquant `window.confirm()` et non-bloquante `navigator.notification.confirm()` sont disponibles.

## navigator.notification.prompt

Affiche une boîte de dialogue natif qui est plus personnalisable que le navigateur `prompt` fonction.

    Navigator.notification.prompt (message, promptCallback, [title], [buttonLabels], [defaultText])
    

  * **message**: message de la boîte de dialogue. *(String)*

  * **promptCallback**: rappel d'invoquer avec l'index du bouton pressé (1, 2 ou 3) ou lorsque la boîte de dialogue est fermée sans une presse de bouton (0). *(Fonction)*

  * **titre**: titre *(String)* (facultatif, la valeur par défaut de dialogue`Prompt`)

  * **buttonLabels**: tableau de chaînes spécifiant les bouton *(Array)* (facultatif, par défaut, les étiquettes`["OK","Cancel"]`)

  * **defaultText**: zone de texte par défaut entrée valeur ( `String` ) (en option, par défaut : chaîne vide)

### promptCallback

Le `promptCallback` s'exécute lorsque l'utilisateur appuie sur un bouton dans la boîte de dialogue d'invite. Le `results` objet passé au rappel contient les propriétés suivantes :

  * **buttonIndex**: l'index du bouton activé. *(Nombre)* Notez que l'index utilise base d'indexation, la valeur est `1` , `2` , `3` , etc..

  * **entrée 1**: le texte entré dans la boîte de dialogue d'invite. *(String)*

### Exemple

    function onPrompt(results) {alert (« Vous avez sélectionné le numéro du bouton » + results.buttonIndex + « et saisi » + results.input1);}
    
    Navigator.notification.prompt ('Veuillez saisir votre nom', / / message onPrompt, / / rappel à appeler « Registration », / / title ['Ok', 'Exit'], / / buttonLabels « Jane Doe » / / defaultText) ;
    

### Plates-formes supportées

  * Amazon Fire OS
  * Android
  * Firefox OS
  * iOS
  * Windows Phone 7 et 8
  * Windows 8
  * Windows

### Quirks Android

  * Android prend en charge un maximum de trois boutons et ignore plus que cela.

  * Sur Android 3.0 et versions ultérieures, les boutons sont affichés dans l'ordre inverse pour les appareils qui utilisent le thème Holo.

### Bizarreries de Windows

  * Sous Windows, dialogue d'invite est basé sur html en raison de l'absence de ces api native.

### Firefox OS Quirks :

Les deux indigènes bloquant `window.prompt()` et non-bloquante `navigator.notification.prompt()` sont disponibles.

## navigator.notification.beep

Le dispositif joue un bip sonore.

    Navigator.notification.Beep(Times) ;
    

  * **temps**: le nombre de fois répéter le bip. *(Nombre)*

### Exemple

    Deux bips !
    Navigator.notification.Beep(2) ;
    

### Plates-formes supportées

  * Amazon Fire OS
  * Android
  * BlackBerry 10
  * iOS
  * Paciarelli
  * Windows Phone 7 et 8
  * Windows 8

### Amazon Fire OS Quirks

  * Amazon Fire OS joue la valeur par défaut le **Son de Notification** spécifié sous le panneau **d'affichage des réglages/& Sound** .

### Quirks Android

  * Android joue la **sonnerie de Notification** spécifié sous le panneau des **réglages/son et affichage** de valeur par défaut.

### Notes au sujet de Windows Phone 7 et 8

  * S'appuie sur un fichier générique bip de la distribution de Cordova.

### Bizarreries de paciarelli

  * Paciarelli implémente les bips en lisant un fichier audio via les médias API.

  * Le fichier sonore doit être court, doit se trouver dans un `sounds` sous-répertoire du répertoire racine de l'application et doit être nommé`beep.wav`.