cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject cordova-plugin-dialogs git commit: CB-8653 Updated Readme
Date Sat, 14 Mar 2015 02:15:06 GMT
Repository: cordova-plugin-dialogs
Updated Branches:
  refs/heads/master f85ef9ad8 -> a05bb882a


CB-8653 Updated Readme


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/commit/a05bb882
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/tree/a05bb882
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/diff/a05bb882

Branch: refs/heads/master
Commit: a05bb882ac248cff8f2a072d564ca9e0097a39ae
Parents: f85ef9a
Author: Steve Gill <stevengill97@gmail.com>
Authored: Fri Mar 13 19:14:56 2015 -0700
Committer: Steve Gill <stevengill97@gmail.com>
Committed: Fri Mar 13 19:14:56 2015 -0700

----------------------------------------------------------------------
 README.md    | 254 +++++++++++++++++++++++++++++++++++++++++++++++++-
 doc/index.md | 273 ------------------------------------------------------
 2 files changed, 252 insertions(+), 275 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/blob/a05bb882/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 75eff13..73059f0 100644
--- a/README.md
+++ b/README.md
@@ -17,9 +17,259 @@
          under the License.
 -->
 
-# org.apache.cordova.dialogs
+# cordova-plugin-dialogs
 
 [![Build Status](https://travis-ci.org/apache/cordova-plugin-dialogs.svg)](https://travis-ci.org/apache/cordova-plugin-dialogs)
 
+This plugin provides access to some native dialog UI elements
+via a global `navigator.notification` object.
+
+Although the object is attached to the global scoped `navigator`, it is not available until
after the `deviceready` event.
+
+    document.addEventListener("deviceready", onDeviceReady, false);
+    function onDeviceReady() {
+        console.log(navigator.notification);
+    }
+
+## Installation
+
+    cordova plugin add cordova-plugin-dialogs
+
+## Methods
+
+- `navigator.notification.alert`
+- `navigator.notification.confirm`
+- `navigator.notification.prompt`
+- `navigator.notification.beep`
+
+## navigator.notification.alert
+
+Shows a custom alert or dialog box.  Most Cordova implementations use a native
+dialog box for this feature, but some platforms use the browser's `alert`
+function, which is typically less customizable.
+
+    navigator.notification.alert(message, alertCallback, [title], [buttonName])
+
+- __message__: Dialog message. _(String)_
+
+- __alertCallback__: Callback to invoke when alert dialog is dismissed. _(Function)_
+
+- __title__: Dialog title. _(String)_ (Optional, defaults to `Alert`)
+
+- __buttonName__: Button name. _(String)_ (Optional, defaults to `OK`)
+
+
+### Example
+
+    function alertDismissed() {
+        // do something
+    }
+
+    navigator.notification.alert(
+        'You are the winner!',  // message
+        alertDismissed,         // callback
+        'Game Over',            // title
+        'Done'                  // buttonName
+    );
+
+### Supported Platforms
+
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+- Windows
+
+### Windows Phone 7 and 8 Quirks
+
+- There is no built-in browser alert, but you can bind one as follows to call `alert()` in
the global scope:
+
+        window.alert = navigator.notification.alert;
+
+- Both `alert` and `confirm` are non-blocking calls, results of which are only available
asynchronously.
+
+### Firefox OS Quirks:
+
+Both native-blocking `window.alert()` and non-blocking `navigator.notification.alert()` are
available.
+
+### BlackBerry 10 Quirks
+`navigator.notification.alert('text', callback, 'title', 'text')` callback parameter is passed
the number 1.
+
+## navigator.notification.confirm
+
+Displays a customizable confirmation dialog box.
+
+    navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])
+
+- __message__: Dialog message. _(String)_
+
+- __confirmCallback__: Callback to invoke with index of button pressed (1, 2, or 3) or when
the dialog is dismissed without a button press (0). _(Function)_
+
+- __title__: Dialog title. _(String)_ (Optional, defaults to `Confirm`)
+
+- __buttonLabels__: Array of strings specifying button labels. _(Array)_  (Optional, defaults
to [`OK,Cancel`])
+
+
+### confirmCallback
+
+The `confirmCallback` executes when the user presses one of the
+buttons in the confirmation dialog box.
+
+The callback takes the argument `buttonIndex` _(Number)_, which is the
+index of the pressed button. Note that the index uses one-based
+indexing, so the value is `1`, `2`, `3`, etc.
+
+### Example
+
+    function onConfirm(buttonIndex) {
+        alert('You selected button ' + buttonIndex);
+    }
+
+    navigator.notification.confirm(
+        'You are the winner!', // message
+         onConfirm,            // callback to invoke with index of button pressed
+        'Game Over',           // title
+        ['Restart','Exit']     // buttonLabels
+    );
+
+### Supported Platforms
+
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+- Windows
+
+### Windows Phone 7 and 8 Quirks
+
+- There is no built-in browser function for `window.confirm`, but you can bind it by assigning:
+
+        window.confirm = navigator.notification.confirm;
+
+- Calls to `alert` and `confirm` are non-blocking, so the result is only available asynchronously.
+
+### Windows Quirks
+
+- On Windows8/8.1 it is not possible to add more than three buttons to MessageDialog instance.
+
+- On Windows Phone 8.1 it's not possible to show dialog with more than two buttons.
+
+### Firefox OS Quirks:
+
+Both native-blocking `window.confirm()` and non-blocking `navigator.notification.confirm()`
are available.
+
+## navigator.notification.prompt
+
+Displays a native dialog box that is more customizable than the browser's `prompt` function.
+
+    navigator.notification.prompt(message, promptCallback, [title], [buttonLabels], [defaultText])
+
+- __message__: Dialog message. _(String)_
+
+- __promptCallback__: Callback to invoke with index of button pressed (1, 2, or 3) or when
the dialog is dismissed without a button press (0). _(Function)_
+
+- __title__: Dialog title _(String)_ (Optional, defaults to `Prompt`)
+
+- __buttonLabels__: Array of strings specifying button labels _(Array)_ (Optional, defaults
to `["OK","Cancel"]`)
+
+- __defaultText__: Default textbox input value (`String`) (Optional, Default: empty string)
+
+### promptCallback
+
+The `promptCallback` executes when the user presses one of the buttons
+in the prompt dialog box. The `results` object passed to the callback
+contains the following properties:
+
+- __buttonIndex__: The index of the pressed button. _(Number)_ Note that the index uses one-based
indexing, so the value is `1`, `2`, `3`, etc.
+
+
+
+- __input1__: The text entered in the prompt dialog box. _(String)_
+
+### Example
+
+    function onPrompt(results) {
+        alert("You selected button number " + results.buttonIndex + " and entered " + results.input1);
+    }
+
+    navigator.notification.prompt(
+        'Please enter your name',  // message
+        onPrompt,                  // callback to invoke
+        'Registration',            // title
+        ['Ok','Exit'],             // buttonLabels
+        'Jane Doe'                 // defaultText
+    );
+
+### Supported Platforms
+
+- Amazon Fire OS
+- Android
+- Firefox OS
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+- Windows
+
+### Android Quirks
+
+- Android supports a maximum of three buttons, and ignores any more than that.
+
+- On Android 3.0 and later, buttons are displayed in reverse order for devices that use the
Holo theme.
+
+### Windows Quirks
+
+- On Windows prompt dialog is html-based due to lack of such native api.
+
+### Firefox OS Quirks:
+
+Both native-blocking `window.prompt()` and non-blocking `navigator.notification.prompt()`
are available.
+
+## navigator.notification.beep
+
+The device plays a beep sound.
+
+    navigator.notification.beep(times);
+
+- __times__: The number of times to repeat the beep. _(Number)_
+
+### Example
+
+    // Beep twice!
+    navigator.notification.beep(2);
+
+### Supported Platforms
+
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+### Amazon Fire OS Quirks
+
+- Amazon Fire OS plays the default __Notification Sound__ specified under the __Settings/Display
& Sound__ panel.
+
+### Android Quirks
+
+- Android plays the default __Notification ringtone__ specified under the __Settings/Sound
& Display__ panel.
+
+### Windows Phone 7 and 8 Quirks
+
+- Relies on a generic beep file from the Cordova distribution.
+
+### Tizen Quirks
+
+- Tizen implements beeps by playing an audio file via the media API.
+
+- The beep file must be short, must be located in a `sounds` subdirectory of the application's
root directory, and must be named `beep.wav`.
 
-Plugin documentation: [doc/index.md](doc/index.md)

http://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs/blob/a05bb882/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
deleted file mode 100644
index d891092..0000000
--- a/doc/index.md
+++ /dev/null
@@ -1,273 +0,0 @@
-<!---
-    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.
--->
-
-# org.apache.cordova.dialogs
-
-This plugin provides access to some native dialog UI elements
-via a global `navigator.notification` object.
-
-Although the object is attached to the global scoped `navigator`, it is not available until
after the `deviceready` event.
-
-    document.addEventListener("deviceready", onDeviceReady, false);
-    function onDeviceReady() {
-        console.log(navigator.notification);
-    }
-
-## Installation
-
-    cordova plugin add org.apache.cordova.dialogs
-
-## Methods
-
-- `navigator.notification.alert`
-- `navigator.notification.confirm`
-- `navigator.notification.prompt`
-- `navigator.notification.beep`
-
-## navigator.notification.alert
-
-Shows a custom alert or dialog box.  Most Cordova implementations use a native
-dialog box for this feature, but some platforms use the browser's `alert`
-function, which is typically less customizable.
-
-    navigator.notification.alert(message, alertCallback, [title], [buttonName])
-
-- __message__: Dialog message. _(String)_
-
-- __alertCallback__: Callback to invoke when alert dialog is dismissed. _(Function)_
-
-- __title__: Dialog title. _(String)_ (Optional, defaults to `Alert`)
-
-- __buttonName__: Button name. _(String)_ (Optional, defaults to `OK`)
-
-
-### Example
-
-    function alertDismissed() {
-        // do something
-    }
-
-    navigator.notification.alert(
-        'You are the winner!',  // message
-        alertDismissed,         // callback
-        'Game Over',            // title
-        'Done'                  // buttonName
-    );
-
-### Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- Firefox OS
-- iOS
-- Tizen
-- Windows Phone 7 and 8
-- Windows 8
-- Windows
-
-### Windows Phone 7 and 8 Quirks
-
-- There is no built-in browser alert, but you can bind one as follows to call `alert()` in
the global scope:
-
-        window.alert = navigator.notification.alert;
-
-- Both `alert` and `confirm` are non-blocking calls, results of which are only available
asynchronously.
-
-### Firefox OS Quirks:
-
-Both native-blocking `window.alert()` and non-blocking `navigator.notification.alert()` are
available.
-
-### BlackBerry 10 Quirks
-`navigator.notification.alert('text', callback, 'title', 'text')` callback parameter is passed
the number 1.
-
-## navigator.notification.confirm
-
-Displays a customizable confirmation dialog box.
-
-    navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])
-
-- __message__: Dialog message. _(String)_
-
-- __confirmCallback__: Callback to invoke with index of button pressed (1, 2, or 3) or when
the dialog is dismissed without a button press (0). _(Function)_
-
-- __title__: Dialog title. _(String)_ (Optional, defaults to `Confirm`)
-
-- __buttonLabels__: Array of strings specifying button labels. _(Array)_  (Optional, defaults
to [`OK,Cancel`])
-
-
-### confirmCallback
-
-The `confirmCallback` executes when the user presses one of the
-buttons in the confirmation dialog box.
-
-The callback takes the argument `buttonIndex` _(Number)_, which is the
-index of the pressed button. Note that the index uses one-based
-indexing, so the value is `1`, `2`, `3`, etc.
-
-### Example
-
-    function onConfirm(buttonIndex) {
-        alert('You selected button ' + buttonIndex);
-    }
-
-    navigator.notification.confirm(
-        'You are the winner!', // message
-         onConfirm,            // callback to invoke with index of button pressed
-        'Game Over',           // title
-        ['Restart','Exit']     // buttonLabels
-    );
-
-### Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- Firefox OS
-- iOS
-- Tizen
-- Windows Phone 7 and 8
-- Windows 8
-- Windows
-
-### Windows Phone 7 and 8 Quirks
-
-- There is no built-in browser function for `window.confirm`, but you can bind it by assigning:
-
-        window.confirm = navigator.notification.confirm;
-
-- Calls to `alert` and `confirm` are non-blocking, so the result is only available asynchronously.
-
-### Windows Quirks
-
-- On Windows8/8.1 it is not possible to add more than three buttons to MessageDialog instance.
-
-- On Windows Phone 8.1 it's not possible to show dialog with more than two buttons.
-
-### Firefox OS Quirks:
-
-Both native-blocking `window.confirm()` and non-blocking `navigator.notification.confirm()`
are available.
-
-## navigator.notification.prompt
-
-Displays a native dialog box that is more customizable than the browser's `prompt` function.
-
-    navigator.notification.prompt(message, promptCallback, [title], [buttonLabels], [defaultText])
-
-- __message__: Dialog message. _(String)_
-
-- __promptCallback__: Callback to invoke with index of button pressed (1, 2, or 3) or when
the dialog is dismissed without a button press (0). _(Function)_
-
-- __title__: Dialog title _(String)_ (Optional, defaults to `Prompt`)
-
-- __buttonLabels__: Array of strings specifying button labels _(Array)_ (Optional, defaults
to `["OK","Cancel"]`)
-
-- __defaultText__: Default textbox input value (`String`) (Optional, Default: empty string)
-
-### promptCallback
-
-The `promptCallback` executes when the user presses one of the buttons
-in the prompt dialog box. The `results` object passed to the callback
-contains the following properties:
-
-- __buttonIndex__: The index of the pressed button. _(Number)_ Note that the index uses one-based
indexing, so the value is `1`, `2`, `3`, etc.
-
-
-
-- __input1__: The text entered in the prompt dialog box. _(String)_
-
-### Example
-
-    function onPrompt(results) {
-        alert("You selected button number " + results.buttonIndex + " and entered " + results.input1);
-    }
-
-    navigator.notification.prompt(
-        'Please enter your name',  // message
-        onPrompt,                  // callback to invoke
-        'Registration',            // title
-        ['Ok','Exit'],             // buttonLabels
-        'Jane Doe'                 // defaultText
-    );
-
-### Supported Platforms
-
-- Amazon Fire OS
-- Android
-- Firefox OS
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-- Windows
-
-### Android Quirks
-
-- Android supports a maximum of three buttons, and ignores any more than that.
-
-- On Android 3.0 and later, buttons are displayed in reverse order for devices that use the
Holo theme.
-
-### Windows Quirks
-
-- On Windows prompt dialog is html-based due to lack of such native api.
-
-### Firefox OS Quirks:
-
-Both native-blocking `window.prompt()` and non-blocking `navigator.notification.prompt()`
are available.
-
-## navigator.notification.beep
-
-The device plays a beep sound.
-
-    navigator.notification.beep(times);
-
-- __times__: The number of times to repeat the beep. _(Number)_
-
-### Example
-
-    // Beep twice!
-    navigator.notification.beep(2);
-
-### Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Tizen
-- Windows Phone 7 and 8
-- Windows 8
-
-### Amazon Fire OS Quirks
-
-- Amazon Fire OS plays the default __Notification Sound__ specified under the __Settings/Display
& Sound__ panel.
-
-### Android Quirks
-
-- Android plays the default __Notification ringtone__ specified under the __Settings/Sound
& Display__ panel.
-
-### Windows Phone 7 and 8 Quirks
-
-- Relies on a generic beep file from the Cordova distribution.
-
-### Tizen Quirks
-
-- Tizen implements beeps by playing an audio file via the media API.
-
-- The beep file must be short, must be located in a `sounds` subdirectory of the application's
root directory, and must be named `beep.wav`.
-


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


Mime
View raw message