Migrate additional docs to the new format

Summary: [DOCS] Closes #16874 Differential Revision: D6375515 Pulled By: hramos fbshipit-source-id: 64359b45a37c7b478919121573ca04dbb1ce6609
facebook · Nov 20, 2017 · 79e24ed · 79e24ed
1 parent f587f8d
commit 79e24ed
Show file tree

Hide file tree

Showing 19 changed files with 1,336 additions and 1,406 deletions.
diff --git a/Libraries/ActionSheetIOS/ActionSheetIOS.js b/Libraries/ActionSheetIOS/ActionSheetIOS.js
@@ -16,34 +16,27 @@ var RCTActionSheetManager = require('NativeModules').ActionSheetManager;
 var invariant = require('fbjs/lib/invariant');
 var processColor = require('processColor');
 
+/**
+ * Display action sheets and share sheets on iOS.
+ * 
+ * See http://facebook.github.io/react-native/docs/actionsheetios.html
+ */
 var ActionSheetIOS = {
   /**
-   * Display an iOS action sheet. The `options` object must contain one or more
-   * of:
-   *
+   * Display an iOS action sheet.
+   * 
+   * The `options` object must contain one or more of:
+   * 
    * - `options` (array of strings) - a list of button titles (required)
    * - `cancelButtonIndex` (int) - index of cancel button in `options`
    * - `destructiveButtonIndex` (int) - index of destructive button in `options`
    * - `title` (string) - a title to show above the action sheet
    * - `message` (string) - a message to show below the title
-   * - `tintColor` (color) - tint color of the buttons
-   *
+   * 
    * The 'callback' function takes one parameter, the zero-based index
    * of the selected item.
-   *
-   * Minimal example:
    * 
-   * ```
-   * ActionSheetIOS.showActionSheetWithOptions({
-   *   options: ['Remove', 'Cancel'],
-   *   destructiveButtonIndex: 1,
-   *   cancelButtonIndex: 0,
-   * },
-   * (buttonIndex) => {
-   *   if (buttonIndex === 1) { // destructive action }
-   * });
-   * ```
-   *
+   * See http://facebook.github.io/react-native/docs/actionsheetios.html#showactionsheetwithoptions
    */
   showActionSheetWithOptions(options: Object, callback: Function) {
     invariant(
@@ -68,13 +61,10 @@ var ActionSheetIOS = {
    * - `url` (string) - a URL to share
    * - `message` (string) - a message to share
    * - `subject` (string) - a subject for the message
-   * - `excludedActivityTypes` (array) - the activities to exclude from the ActionSheet
+   * - `excludedActivityTypes` (array) - the activities to exclude from 
+   *   the ActionSheet
    * - `tintColor` (color) - tint color of the buttons
    *
-   * NOTE: if `url` points to a local file, or is a base64-encoded
-   * uri, the file it points to will be loaded and shared directly.
-   * In this way, you can share images, videos, PDF files, etc.
-   *
    * The 'failureCallback' function takes one parameter, an error object.
    * The only property defined on this object is an optional `stack` property
    * of type `string`.
@@ -83,6 +73,8 @@ var ActionSheetIOS = {
    *
    * - a boolean value signifying success or failure
    * - a string that, in the case of success, indicates the method of sharing
+   * 
+   * See http://facebook.github.io/react-native/docs/actionsheetios.html#showshareactionsheetwithoptions
    */
   showShareActionSheetWithOptions(
     options: Object,

diff --git a/Libraries/Alert/Alert.js b/Libraries/Alert/Alert.js
@@ -30,54 +30,16 @@ type Options = {
 
 /**
  * Launches an alert dialog with the specified title and message.
- *
- * Optionally provide a list of buttons. Tapping any button will fire the
- * respective onPress callback and dismiss the alert. By default, the only
- * button will be an 'OK' button.
- *
- * This is an API that works both on iOS and Android and can show static
- * alerts. To show an alert that prompts the user to enter some information,
- * see `AlertIOS`; entering text in an alert is common on iOS only.
- *
- * ## iOS
- *
- * On iOS you can specify any number of buttons. Each button can optionally
- * specify a style, which is one of 'default', 'cancel' or 'destructive'.
- *
- * ## Android
- *
- * On Android at most three buttons can be specified. Android has a concept
- * of a neutral, negative and a positive button:
- *
- *   - If you specify one button, it will be the 'positive' one (such as 'OK')
- *   - Two buttons mean 'negative', 'positive' (such as 'Cancel', 'OK')
- *   - Three buttons mean 'neutral', 'negative', 'positive' (such as 'Later', 'Cancel', 'OK')
- *
- * By default alerts on Android can be dismissed by tapping outside of the alert
- * box. This event can be handled by providing an optional `options` parameter,
- * with an `onDismiss` callback property `{ onDismiss: () => {} }`.
- *
- * Alternatively, the dismissing behavior can be disabled altogether by providing
- * an optional `options` parameter with the `cancelable` property set to `false`
- * i.e. `{ cancelable: false }`
- *
- * Example usage:
- * ```
- * // Works on both iOS and Android
- * Alert.alert(
- *   'Alert Title',
- *   'My Alert Msg',
- *   [
- *     {text: 'Ask me later', onPress: () => console.log('Ask me later pressed')},
- *     {text: 'Cancel', onPress: () => console.log('Cancel Pressed'), style: 'cancel'},
- *     {text: 'OK', onPress: () => console.log('OK Pressed')},
- *   ],
- *   { cancelable: false }
- * )
- * ```
+ * 
+ * See http://facebook.github.io/react-native/docs/alert.html
  */
 class Alert {
 
+  /**
+   * Launches an alert dialog with the specified title and message.
+   * 
+   * See http://facebook.github.io/react-native/docs/alert.html#alert
+   */
   static alert(
     title: ?string,
     message?: ?string,

diff --git a/Libraries/Alert/AlertIOS.js b/Libraries/Alert/AlertIOS.js
@@ -77,60 +77,15 @@ export type ButtonsArray = Array<{
 }>;
 
 /**
- * @description
- * `AlertIOS` provides functionality to create an iOS alert dialog with a
- * message or create a prompt for user input.
- *
- * Creating an iOS alert:
- *
- * ```
- * AlertIOS.alert(
- *  'Sync Complete',
- *  'All your data are belong to us.'
- * );
- * ```
- *
- * Creating an iOS prompt:
- *
- * ```
- * AlertIOS.prompt(
- *   'Enter a value',
- *   null,
- *   text => console.log("You entered "+text)
- * );
- * ```
- *
- * We recommend using the [`Alert.alert`](docs/alert.html) method for
- * cross-platform support if you don't need to create iOS-only prompts.
+ * Use `AlertIOS` to display an alert dialog with a message or to create a prompt for user input on iOS. If you don't need to prompt for user input, we recommend using `Alert.alert() for cross-platform support.
  *
+ * See http://facebook.github.io/react-native/docs/alertios.html
  */
 class AlertIOS {
   /**
    * Create and display a popup alert.
-   * @static
-   * @method alert
-   * @param title The dialog's title. Passing null or '' will hide the title.
-   * @param message An optional message that appears below
-   *     the dialog's title.
-   * @param callbackOrButtons This optional argument should
-   *    be either a single-argument function or an array of buttons. If passed
-   *    a function, it will be called when the user taps 'OK'.
-   *
-   *    If passed an array of button configurations, each button should include
-   *    a `text` key, as well as optional `onPress` and `style` keys. `style`
-   *    should be one of 'default', 'cancel' or 'destructive'.
-   * @param type Deprecated, do not use.
    *
-   * @example <caption>Example with custom buttons</caption>
-   *
-   * AlertIOS.alert(
-   *  'Update available',
-   *  'Keep your app up to date to enjoy the latest features',
-   *  [
-   *    {text: 'Cancel', onPress: () => console.log('Cancel Pressed'), style: 'cancel'},
-   *    {text: 'Install', onPress: () => console.log('Install Pressed')},
-   *  ],
-   * );
+   * See http://facebook.github.io/react-native/docs/alertios.html#alert
    */
   static alert(
     title: ?string,
@@ -148,48 +103,8 @@ class AlertIOS {
 
   /**
    * Create and display a prompt to enter some text.
-   * @static
-   * @method prompt
-   * @param title The dialog's title.
-   * @param message An optional message that appears above the text
-   *    input.
-   * @param callbackOrButtons This optional argument should
-   *    be either a single-argument function or an array of buttons. If passed
-   *    a function, it will be called with the prompt's value when the user
-   *    taps 'OK'.
-   *
-   *    If passed an array of button configurations, each button should include
-   *    a `text` key, as well as optional `onPress` and `style` keys (see
-   *    example). `style` should be one of 'default', 'cancel' or 'destructive'.
-   * @param type This configures the text input. One of 'plain-text',
-   *    'secure-text' or 'login-password'.
-   * @param defaultValue The default text in text input.
-   * @param keyboardType The keyboard type of first text field(if exists).
-   *    One of 'default', 'email-address', 'numeric', 'phone-pad',
-   *    'ascii-capable', 'numbers-and-punctuation', 'url', 'number-pad',
-   *    'name-phone-pad', 'decimal-pad', 'twitter' or 'web-search'.
-   *
-   * @example <caption>Example with custom buttons</caption>
-   *
-   * AlertIOS.prompt(
-   *   'Enter password',
-   *   'Enter your password to claim your $1.5B in lottery winnings',
-   *   [
-   *     {text: 'Cancel', onPress: () => console.log('Cancel Pressed'), style: 'cancel'},
-   *     {text: 'OK', onPress: password => console.log('OK Pressed, password: ' + password)},
-   *   ],
-   *   'secure-text'
-   * );
-   *
-   * @example <caption>Example with the default button and a custom callback</caption>
-   *
-   * AlertIOS.prompt(
-   *   'Update username',
-   *   null,
-   *   text => console.log("Your username is "+text),
-   *   null,
-   *   'default'
-   * );
+   * 
+   * See http://facebook.github.io/react-native/docs/alertios.html#prompt
    */
   static prompt(
     title: ?string,