Improved documentation for ActionSheetIOS.js

Summary:
This change improves the documentation for `ActionSheetIOS.js`. It's a bit skimpy as is.
Closes https://github.com/facebook/react-native/pull/16030

Differential Revision: D5882446

Pulled By: hramos

fbshipit-source-id: b59ce299a9142ebf015ed674c59e1e435deb759a
This commit is contained in:
Petter Hesselberg 2017-09-21 11:41:12 -07:00 committed by Facebook Github Bot
parent f25233b15f
commit 5317b68e27
1 changed files with 12 additions and 0 deletions

View File

@ -26,6 +26,9 @@ var ActionSheetIOS = {
* - `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
*
* The 'callback' function takes one parameter, the zero-based index
* of the selected item.
*/
showActionSheetWithOptions(options: Object, callback: Function) {
invariant(
@ -55,6 +58,15 @@ var ActionSheetIOS = {
* 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`.
*
* The 'successCallback' function takes two parameters:
*
* - a boolean value signifying success or failure
* - a string that, in the case of success, indicates the method of sharing
*/
showShareActionSheetWithOptions(
options: Object,