From ab20bdfb04be6464cb0794ca3cc71fb6126758f3 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Wed, 19 Jul 2017 23:47:25 +0000 Subject: [PATCH] Updated docs for 0.46 --- docs/accessibility.html | 2 +- docs/accessibilityinfo.html | 2 +- docs/actionsheetios.html | 2 +- docs/activityindicator.html | 2 +- docs/adsupportios.html | 2 +- docs/alert.html | 2 +- docs/alertios.html | 2 +- docs/android-building-from-source.html | 2 +- docs/animated.html | 2 +- docs/animations.html | 2 +- docs/appregistry.html | 2 +- docs/appstate.html | 2 +- docs/asyncstorage.html | 2 +- docs/backandroid.html | 2 +- docs/backhandler.html | 2 +- docs/building-for-apple-tv.html | 2 +- docs/button.html | 2 +- docs/cameraroll.html | 2 +- docs/clipboard.html | 2 +- docs/colors.html | 2 +- docs/communication-ios.html | 2 +- docs/components-and-apis.html | 2 +- docs/contributing.html | 32 +++++++++++++++++++ docs/datepickerandroid.html | 2 +- docs/datepickerios.html | 2 +- docs/debugging.html | 2 +- docs/dimensions.html | 2 +- docs/direct-manipulation.html | 2 +- docs/drawerlayoutandroid.html | 2 +- docs/easing.html | 2 +- docs/flatlist.html | 2 +- docs/flexbox.html | 2 +- docs/geolocation.html | 2 +- docs/gesture-responder-system.html | 2 +- docs/getting-started.html | 2 +- docs/handling-text-input.html | 2 +- docs/handling-touches.html | 2 +- docs/headless-js-android.html | 2 +- docs/height-and-width.html | 2 +- docs/image.html | 2 +- docs/imageeditor.html | 2 +- docs/imagepickerios.html | 2 +- docs/images.html | 2 +- docs/imagestore.html | 2 +- docs/imagestyleproptypes.html | 2 +- docs/integration-with-existing-apps.html | 2 +- docs/interactionmanager.html | 2 +- docs/javascript-environment.html | 2 +- docs/keyboard.html | 2 +- docs/keyboardavoidingview.html | 2 +- docs/layout-props.html | 2 +- docs/layoutanimation.html | 2 +- docs/linking-libraries-ios.html | 2 +- docs/linking.html | 2 +- docs/listview.html | 2 +- docs/listviewdatasource.html | 2 +- docs/modal.html | 2 +- docs/more-resources.html | 2 +- docs/native-components-android.html | 2 +- docs/native-components-ios.html | 2 +- docs/native-modules-android.html | 2 +- docs/native-modules-ios.html | 4 +-- docs/navigation.html | 2 +- docs/navigatorios.html | 2 +- docs/netinfo.html | 2 +- docs/network.html | 2 +- docs/panresponder.html | 2 +- docs/performance.html | 2 +- docs/permissionsandroid.html | 2 +- docs/picker.html | 2 +- docs/pickerios.html | 2 +- docs/pixelratio.html | 2 +- docs/platform-specific-code.html | 2 +- docs/progressbarandroid.html | 2 +- docs/progressviewios.html | 2 +- docs/props.html | 2 +- docs/pushnotificationios.html | 2 +- docs/refreshcontrol.html | 2 +- docs/running-on-device.html | 2 +- docs/running-on-simulator-ios.html | 2 +- docs/scrollview.html | 2 +- docs/sectionlist.html | 2 +- docs/segmentedcontrolios.html | 2 +- docs/settings.html | 2 +- docs/shadow-props.html | 2 +- docs/share.html | 2 +- docs/signed-apk-android.html | 2 +- docs/slider.html | 2 +- docs/snapshotviewios.html | 2 +- docs/state.html | 2 +- docs/statusbar.html | 2 +- docs/statusbarios.html | 2 +- docs/style.html | 2 +- docs/stylesheet.html | 2 +- docs/switch.html | 2 +- docs/systrace.html | 2 +- docs/tabbarios-item.html | 2 +- docs/tabbarios.html | 2 +- docs/testing.html | 4 +-- docs/text.html | 2 +- docs/textinput.html | 2 +- docs/textstyleproptypes.html | 2 +- docs/timepickerandroid.html | 2 +- docs/timers.html | 2 +- docs/toastandroid.html | 2 +- docs/toolbarandroid.html | 2 +- docs/touchablehighlight.html | 2 +- docs/touchablenativefeedback.html | 2 +- docs/touchableopacity.html | 2 +- docs/touchablewithoutfeedback.html | 2 +- docs/transforms.html | 2 +- docs/troubleshooting.html | 2 +- docs/tutorial.html | 2 +- docs/understanding-cli.html | 2 +- docs/upgrading.html | 4 +-- docs/using-a-listview.html | 2 +- docs/using-a-scrollview.html | 2 +- docs/vibration.html | 2 +- docs/vibrationios.html | 2 +- docs/view.html | 2 +- docs/viewpagerandroid.html | 2 +- docs/viewproptypes.html | 2 +- docs/viewstyleproptypes.html | 2 +- docs/virtualizedlist.html | 2 +- docs/webview.html | 2 +- js/scripts.js | 3 -- releases/0.46/docs/accessibility.html | 2 +- releases/0.46/docs/accessibilityinfo.html | 2 +- releases/0.46/docs/actionsheetios.html | 2 +- releases/0.46/docs/activityindicator.html | 2 +- releases/0.46/docs/adsupportios.html | 2 +- releases/0.46/docs/alert.html | 2 +- releases/0.46/docs/alertios.html | 2 +- .../docs/android-building-from-source.html | 2 +- releases/0.46/docs/animated.html | 2 +- releases/0.46/docs/animations.html | 2 +- releases/0.46/docs/appregistry.html | 2 +- releases/0.46/docs/appstate.html | 2 +- releases/0.46/docs/asyncstorage.html | 2 +- releases/0.46/docs/backandroid.html | 2 +- releases/0.46/docs/backhandler.html | 2 +- releases/0.46/docs/building-for-apple-tv.html | 2 +- releases/0.46/docs/button.html | 2 +- releases/0.46/docs/cameraroll.html | 2 +- releases/0.46/docs/clipboard.html | 2 +- releases/0.46/docs/colors.html | 2 +- releases/0.46/docs/communication-ios.html | 2 +- releases/0.46/docs/components-and-apis.html | 2 +- releases/0.46/docs/contributing.html | 32 +++++++++++++++++++ releases/0.46/docs/datepickerandroid.html | 2 +- releases/0.46/docs/datepickerios.html | 2 +- releases/0.46/docs/debugging.html | 2 +- releases/0.46/docs/dimensions.html | 2 +- releases/0.46/docs/direct-manipulation.html | 2 +- releases/0.46/docs/drawerlayoutandroid.html | 2 +- releases/0.46/docs/easing.html | 2 +- releases/0.46/docs/flatlist.html | 2 +- releases/0.46/docs/flexbox.html | 2 +- releases/0.46/docs/geolocation.html | 2 +- .../0.46/docs/gesture-responder-system.html | 2 +- releases/0.46/docs/getting-started.html | 2 +- releases/0.46/docs/handling-text-input.html | 2 +- releases/0.46/docs/handling-touches.html | 2 +- releases/0.46/docs/headless-js-android.html | 2 +- releases/0.46/docs/height-and-width.html | 2 +- releases/0.46/docs/image.html | 2 +- releases/0.46/docs/imageeditor.html | 2 +- releases/0.46/docs/imagepickerios.html | 2 +- releases/0.46/docs/images.html | 2 +- releases/0.46/docs/imagestore.html | 2 +- releases/0.46/docs/imagestyleproptypes.html | 2 +- .../docs/integration-with-existing-apps.html | 2 +- releases/0.46/docs/interactionmanager.html | 2 +- .../0.46/docs/javascript-environment.html | 2 +- releases/0.46/docs/keyboard.html | 2 +- releases/0.46/docs/keyboardavoidingview.html | 2 +- releases/0.46/docs/layout-props.html | 2 +- releases/0.46/docs/layoutanimation.html | 2 +- releases/0.46/docs/linking-libraries-ios.html | 2 +- releases/0.46/docs/linking.html | 2 +- releases/0.46/docs/listview.html | 2 +- releases/0.46/docs/listviewdatasource.html | 2 +- releases/0.46/docs/modal.html | 2 +- releases/0.46/docs/more-resources.html | 2 +- .../0.46/docs/native-components-android.html | 2 +- releases/0.46/docs/native-components-ios.html | 2 +- .../0.46/docs/native-modules-android.html | 2 +- releases/0.46/docs/native-modules-ios.html | 4 +-- releases/0.46/docs/navigation.html | 2 +- releases/0.46/docs/navigatorios.html | 2 +- releases/0.46/docs/netinfo.html | 2 +- releases/0.46/docs/network.html | 2 +- releases/0.46/docs/panresponder.html | 2 +- releases/0.46/docs/performance.html | 2 +- releases/0.46/docs/permissionsandroid.html | 2 +- releases/0.46/docs/picker.html | 2 +- releases/0.46/docs/pickerios.html | 2 +- releases/0.46/docs/pixelratio.html | 2 +- .../0.46/docs/platform-specific-code.html | 2 +- releases/0.46/docs/progressbarandroid.html | 2 +- releases/0.46/docs/progressviewios.html | 2 +- releases/0.46/docs/props.html | 2 +- releases/0.46/docs/pushnotificationios.html | 2 +- releases/0.46/docs/refreshcontrol.html | 2 +- releases/0.46/docs/running-on-device.html | 2 +- .../0.46/docs/running-on-simulator-ios.html | 2 +- releases/0.46/docs/scrollview.html | 2 +- releases/0.46/docs/sectionlist.html | 2 +- releases/0.46/docs/segmentedcontrolios.html | 2 +- releases/0.46/docs/settings.html | 2 +- releases/0.46/docs/shadow-props.html | 2 +- releases/0.46/docs/share.html | 2 +- releases/0.46/docs/signed-apk-android.html | 2 +- releases/0.46/docs/slider.html | 2 +- releases/0.46/docs/snapshotviewios.html | 2 +- releases/0.46/docs/state.html | 2 +- releases/0.46/docs/statusbar.html | 2 +- releases/0.46/docs/statusbarios.html | 2 +- releases/0.46/docs/style.html | 2 +- releases/0.46/docs/stylesheet.html | 2 +- releases/0.46/docs/switch.html | 2 +- releases/0.46/docs/systrace.html | 2 +- releases/0.46/docs/tabbarios-item.html | 2 +- releases/0.46/docs/tabbarios.html | 2 +- releases/0.46/docs/testing.html | 4 +-- releases/0.46/docs/text.html | 2 +- releases/0.46/docs/textinput.html | 2 +- releases/0.46/docs/textstyleproptypes.html | 2 +- releases/0.46/docs/timepickerandroid.html | 2 +- releases/0.46/docs/timers.html | 2 +- releases/0.46/docs/toastandroid.html | 2 +- releases/0.46/docs/toolbarandroid.html | 2 +- releases/0.46/docs/touchablehighlight.html | 2 +- .../0.46/docs/touchablenativefeedback.html | 2 +- releases/0.46/docs/touchableopacity.html | 2 +- .../0.46/docs/touchablewithoutfeedback.html | 2 +- releases/0.46/docs/transforms.html | 2 +- releases/0.46/docs/troubleshooting.html | 2 +- releases/0.46/docs/tutorial.html | 2 +- releases/0.46/docs/understanding-cli.html | 2 +- releases/0.46/docs/upgrading.html | 4 +-- releases/0.46/docs/using-a-listview.html | 2 +- releases/0.46/docs/using-a-scrollview.html | 2 +- releases/0.46/docs/vibration.html | 2 +- releases/0.46/docs/vibrationios.html | 2 +- releases/0.46/docs/view.html | 2 +- releases/0.46/docs/viewpagerandroid.html | 2 +- releases/0.46/docs/viewproptypes.html | 2 +- releases/0.46/docs/viewstyleproptypes.html | 2 +- releases/0.46/docs/virtualizedlist.html | 2 +- releases/0.46/docs/webview.html | 2 +- releases/0.46/js/scripts.js | 3 -- versions.html | 6 ++-- 253 files changed, 321 insertions(+), 263 deletions(-) create mode 100644 docs/contributing.html create mode 100644 releases/0.46/docs/contributing.html diff --git a/docs/accessibility.html b/docs/accessibility.html index 2a52e21c26d..98f4e088584 100644 --- a/docs/accessibility.html +++ b/docs/accessibility.html @@ -1,4 +1,4 @@ -Accessibility

Accessibility #

Native App Accessibility (iOS and Android) #

Both iOS and Android provide APIs for making apps accessible to people with disabilities. In addition, both platforms provide bundled assistive technologies, like the screen readers VoiceOver (iOS) and TalkBack (Android) for the visually impaired. Similarly, in React Native we have included APIs designed to provide developers with support for making apps more accessible. Take note, iOS and Android differ slightly in their approaches, and thus the React Native implementations may vary by platform.

In addition to this documentation, you might find this blog post about React Native accessibility to be useful.

Making Apps Accessible #

Accessibility properties #

accessible (iOS, Android) #

When true, indicates that the view is an accessibility element. When a view is an accessibility element, it groups its children into a single selectable component. By default, all touchable elements are accessible.

On Android, ‘accessible={true}’ property for a react-native View will be translated into native ‘focusable={true}’.

<View accessible={true}> +Accessibility

Accessibility #

Native App Accessibility (iOS and Android) #

Both iOS and Android provide APIs for making apps accessible to people with disabilities. In addition, both platforms provide bundled assistive technologies, like the screen readers VoiceOver (iOS) and TalkBack (Android) for the visually impaired. Similarly, in React Native we have included APIs designed to provide developers with support for making apps more accessible. Take note, iOS and Android differ slightly in their approaches, and thus the React Native implementations may vary by platform.

In addition to this documentation, you might find this blog post about React Native accessibility to be useful.

Making Apps Accessible #

Accessibility properties #

accessible (iOS, Android) #

When true, indicates that the view is an accessibility element. When a view is an accessibility element, it groups its children into a single selectable component. By default, all touchable elements are accessible.

On Android, ‘accessible={true}’ property for a react-native View will be translated into native ‘focusable={true}’.

<View accessible={true}> <Text>text one</Text> <Text>text two</Text> </View>

In the above example, we can't get accessibility focus separately on 'text one' and 'text two'. Instead we get focus on a parent view with 'accessible' property.

accessibilityLabel (iOS, Android) #

When a view is marked as accessible, it is a good practice to set an accessibilityLabel on the view, so that people who use VoiceOver know what element they have selected. VoiceOver will read this string when a user selects the associated element.

To use, set the accessibilityLabel property to a custom string on your View:

<TouchableOpacity accessible={true} accessibilityLabel={'Tap me!'} onPress={this._onPress}> diff --git a/docs/accessibilityinfo.html b/docs/accessibilityinfo.html index 2d5534c379d..f7808ae47da 100644 --- a/docs/accessibilityinfo.html +++ b/docs/accessibilityinfo.html @@ -1,4 +1,4 @@ -AccessibilityInfo

AccessibilityInfo #

Sometimes it's useful to know whether or not the device has a screen reader that is currently active. The +AccessibilityInfo

AccessibilityInfo #

Sometimes it's useful to know whether or not the device has a screen reader that is currently active. The AccessibilityInfo API is designed for this purpose. You can use it to query the current state of the screen reader as well as to register to be notified when the state of the screen reader changes.

Here's a small example illustrating how to use AccessibilityInfo:

class ScreenReaderStatusExample extends React.Component { state = { diff --git a/docs/actionsheetios.html b/docs/actionsheetios.html index 792eb16224e..d26761a35e9 100644 --- a/docs/actionsheetios.html +++ b/docs/actionsheetios.html @@ -1,4 +1,4 @@ -ActionSheetIOS

ActionSheetIOS #

Methods #

static showActionSheetWithOptions(options, callback) #

Display an iOS action sheet. The options object must contain one or more +ActionSheetIOS

ActionSheetIOS #

Methods #

static showActionSheetWithOptions(options, callback) #

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

static showShareActionSheetWithOptions(options, failureCallback, successCallback) #

Display the iOS share sheet. The options object should contain one or both of message and url and can additionally have a subject or excludedActivityTypes:

  • 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

NOTE: if url points to a local file, or is a base64-encoded diff --git a/docs/activityindicator.html b/docs/activityindicator.html index cde39dce6b1..8a7a5cc8863 100644 --- a/docs/activityindicator.html +++ b/docs/activityindicator.html @@ -1,4 +1,4 @@ -ActivityIndicator

ActivityIndicator #

Displays a circular loading indicator.

Props #

animating?: bool #

Whether to show the indicator (true, the default) or hide it (false).

color?: color #

The foreground color of the spinner (default is gray).

size?: enum('small', 'large'), number #

Size of the indicator (default is 'small'). +ActivityIndicator

ActivityIndicator #

Displays a circular loading indicator.

Props #

animating?: bool #

Whether to show the indicator (true, the default) or hide it (false).

color?: color #

The foreground color of the spinner (default is gray).

size?: enum('small', 'large'), number #

Size of the indicator (default is 'small'). Passing a number to the size prop is only supported on Android.

ioshidesWhenStopped?: bool #

Whether the indicator should hide when not animating (true by default).

You can edit the content above on GitHub and send us a pull request!

AdSupportIOS #

AdSupport provides access to the "advertising identifier". If you link this library +AdSupportIOS

AdSupportIOS #

AdSupport provides access to the "advertising identifier". If you link this library in your project, you may need to justify your use for this identifier when submitting your application to the App Store.

In order to use AdSupport in your project, you must link the RCTAdSupport library. In Xcode, you can manually add the RCTAdSupport.m and RCTAdSupport.h files from diff --git a/docs/alert.html b/docs/alert.html index 5cf205d20f5..f3ab576f792 100644 --- a/docs/alert.html +++ b/docs/alert.html @@ -1,4 +1,4 @@ -Alert

Alert #

Launches an alert dialog with the specified title and message.

Optionally provide a list of buttons. Tapping any button will fire the +Alert

Alert #

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, diff --git a/docs/alertios.html b/docs/alertios.html index a928587005f..b64cfc9fef8 100644 --- a/docs/alertios.html +++ b/docs/alertios.html @@ -1,4 +1,4 @@ -AlertIOS

AlertIOS #

AlertIOS provides functionality to create an iOS alert dialog with a +AlertIOS

AlertIOS #

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.' diff --git a/docs/android-building-from-source.html b/docs/android-building-from-source.html index 48bff71f1a2..98088aff334 100644 --- a/docs/android-building-from-source.html +++ b/docs/android-building-from-source.html @@ -1,4 +1,4 @@ -Building React Native from source

Building React Native from source #

You will need to build React Native from source if you want to work on a new feature/bug fix, try out the latest features which are not released yet, or maintain your own fork with patches that cannot be merged to the core.

Prerequisites #

Assuming you have the Android SDK installed, run android to open the Android SDK Manager.

Make sure you have the following installed:

  1. Android SDK version 23 (compileSdkVersion in build.gradle)
  2. SDK build tools version 23.0.1 (buildToolsVersion in build.gradle)
  3. Android Support Repository >= 17 (for Android Support Library)
  4. Android NDK (download links and installation instructions below)

Point Gradle to your Android SDK: #

Step 1: Set environment variables through your local shell.

Note: Files may vary based on shell flavor. See below for examples from common shells.

  • bash: .bash_profile or .bashrc
  • zsh: .zprofile or .zshrc
  • ksh: .profile or $ENV

Example:

export ANDROID_SDK=/Users/your_unix_name/android-sdk-macosx +Building React Native from source

Building React Native from source #

You will need to build React Native from source if you want to work on a new feature/bug fix, try out the latest features which are not released yet, or maintain your own fork with patches that cannot be merged to the core.

Prerequisites #

Assuming you have the Android SDK installed, run android to open the Android SDK Manager.

Make sure you have the following installed:

  1. Android SDK version 23 (compileSdkVersion in build.gradle)
  2. SDK build tools version 23.0.1 (buildToolsVersion in build.gradle)
  3. Android Support Repository >= 17 (for Android Support Library)
  4. Android NDK (download links and installation instructions below)

Point Gradle to your Android SDK: #

Step 1: Set environment variables through your local shell.

Note: Files may vary based on shell flavor. See below for examples from common shells.

  • bash: .bash_profile or .bashrc
  • zsh: .zprofile or .zshrc
  • ksh: .profile or $ENV

Example:

export ANDROID_SDK=/Users/your_unix_name/android-sdk-macosx export ANDROID_NDK=/Users/your_unix_name/android-ndk/android-ndk-r10e

Step 2: Create a local.properties file in the android directory of your react-native app with the following contents:

Example:

sdk.dir=/Users/your_unix_name/android-sdk-macosx ndk.dir=/Users/your_unix_name/android-ndk/android-ndk-r10e

Download links for Android NDK #

  1. Mac OS (64-bit) - http://dl.google.com/android/repository/android-ndk-r10e-darwin-x86_64.zip
  2. Linux (64-bit) - http://dl.google.com/android/repository/android-ndk-r10e-linux-x86_64.zip
  3. Windows (64-bit) - http://dl.google.com/android/repository/android-ndk-r10e-windows-x86_64.zip
  4. Windows (32-bit) - http://dl.google.com/android/repository/android-ndk-r10e-windows-x86.zip

You can find further instructions on the official page.

Building the source #

1. Installing the fork #

First, you need to install react-native from your fork. For example, to install the master branch from the official repo, run the following:

npm install --save github:facebook/react-native#master

Alternatively, you can clone the repo to your node_modules directory and run npm install inside the cloned repo.

2. Adding gradle dependencies #

Add gradle-download-task as dependency in android/build.gradle:

... dependencies { diff --git a/docs/animated.html b/docs/animated.html index d6a2f1ba0f1..15c6bf87671 100644 --- a/docs/animated.html +++ b/docs/animated.html @@ -1,4 +1,4 @@ -Animated

Animated #

The Animated library is designed to make animations fluid, powerful, and +Animated

Animated #

The Animated library is designed to make animations fluid, powerful, and easy to build and maintain. Animated focuses on declarative relationships between inputs and outputs, with configurable transforms in between, and simple start/stop methods to control time-based animation execution.

The simplest workflow for creating an animation is to to create an diff --git a/docs/animations.html b/docs/animations.html index 9b729ded823..c99c5629f5f 100644 --- a/docs/animations.html +++ b/docs/animations.html @@ -1,4 +1,4 @@ -Animations

Animations #

Animations are very important to create a great user experience. +Animations

Animations #

Animations are very important to create a great user experience. Stationary objects must overcome inertia as they start moving. Objects in motion have momentum and rarely come to a stop immediately. Animations allow you to convey physically believable motion in your interface.

React Native provides two complementary animation systems: diff --git a/docs/appregistry.html b/docs/appregistry.html index 58701fd1887..8e5588102b7 100644 --- a/docs/appregistry.html +++ b/docs/appregistry.html @@ -1,4 +1,4 @@ -AppRegistry

AppRegistry #