Skip to content

Commit

Permalink
Improved documentation for ActionSheetIOS.js
Browse files Browse the repository at this point in the history
Summary:
This change improves the documentation for `ActionSheetIOS.js`. It's a bit skimpy as is.
Closes #16030

Differential Revision: D5882446

Pulled By: hramos

fbshipit-source-id: b59ce299a9142ebf015ed674c59e1e435deb759a
  • Loading branch information
Petter Hesselberg authored and facebook-github-bot committed Sep 21, 2017
1 parent f25233b commit 5317b68
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions Libraries/ActionSheetIOS/ActionSheetIOS.js
Expand Up @@ -26,6 +26,9 @@ var ActionSheetIOS = {
* - `destructiveButtonIndex` (int) - index of destructive button in `options` * - `destructiveButtonIndex` (int) - index of destructive button in `options`
* - `title` (string) - a title to show above the action sheet * - `title` (string) - a title to show above the action sheet
* - `message` (string) - a message to show below the title * - `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) { showActionSheetWithOptions(options: Object, callback: Function) {
invariant( invariant(
Expand Down Expand Up @@ -55,6 +58,15 @@ var ActionSheetIOS = {
* NOTE: if `url` points to a local file, or is a base64-encoded * 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. * uri, the file it points to will be loaded and shared directly.
* In this way, you can share images, videos, PDF files, etc. * 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( showShareActionSheetWithOptions(
options: Object, options: Object,
Expand Down

0 comments on commit 5317b68

Please sign in to comment.