From f82ec460026bb9f49d97c211326af8a802e21d27 Mon Sep 17 00:00:00 2001 From: Aakash N S Date: Mon, 2 Nov 2015 02:58:12 +0530 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8bf12bf..c4180be 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ dependencies { compile project(':react-native-dialogs') } ``` -The changes should look like [this](https://github.com/aakashns/react-native-dialogs-example/commit/b58086d8fb9ece99f0e678dd8bf0e689a856bd43) +The changes should look like [this](https://github.com/aakashns/react-native-dialogs-example/commit/b58086d8fb9ece99f0e678dd8bf0e689a856bd43). Next, you need to change the `MainActivity` of your app to extends `FragmentActivity` instead of `Activity` (otherwise dialogs will not be rendered), and register `ReactNativeDialogsPackage` : ```java @@ -48,3 +48,30 @@ public class MainActivity extends FragmentActivity implements DefaultHardwareBac See [this changelog](https://github.com/aakashns/react-native-dialogs-example/commit/52cac27756963bcd2f4fdcd039e1a78028bb0abd) for reference. Now you're finally ready to start using module in your React Native application. See [this changelog](https://github.com/aakashns/react-native-dialogs-example/commit/2d8e02c22275479d2fbbb89f99dcb846834bec9d) for an example that uses `DialogAndroid`. + +Usage +----- +```javascript +var DialogAndroid = require('react-native-dialogs'); + +var options = { + title: 'Hello, World!', + content: 'I\'m just simple Dialog', + positiveText: 'OK', + negativeText: 'Cancel' +}; + +var showDialog = function () { + var dialog = new DialogAndroid(); + dialog.set(options); + dialog.show(); +} +``` +Creation of a dialog works in 3 steps : +1. Create a new dialog using `new DialogAndroid()`. +2. Set some options using `dialog.set(options)`. `set` can be called multiple times, and options from multiple calls will be merged. +3. Show the dialog using `dialog.show()`. + +This library is a thin wrapper over [afollestad/material-dialogs](https://github.com/afollestad/material-dialogs), which provides builders for showing Material Design dialogs in Android apps. The options provided to `set` map more or less directly to the methods provided in the original library. See [its documentation](https://github.com/afollestad/material-dialogs#basic-dialog) for reference. + +The following options are currently supported :