React NativeAccessibility #
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.
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}’.
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.
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}’.
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:
ActionSheetIOS #
Methods #
static showActionSheetWithOptions(options, callback) #
Display an iOS action sheet. The options object must contain one or more
+
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 inoptionsdestructiveButtonIndex(int) - index of destructive button inoptionstitle(string) - a title to show above the action sheetmessage(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 sharemessage(string) - a message to sharesubject(string) - a subject for the messageexcludedActivityTypes(array) - the activities to exclude from the ActionSheet
NOTE: if Displays a circular loading indicator. Whether to show the indicator (true, the default) or hide it (false). Size of the indicator (default is 'small').
-Passing a number to the size prop is only supported on Android. 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! Displays a circular loading indicator. Whether to show the indicator (true, the default) or hide it (false). Size of the indicator (default is 'small').
+Passing a number to the size prop is only supported on Android. 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! Deprecated, use ActivityIndicator instead. Whether to show the indicator (true, the default) or hide it (false). The foreground color of the spinner (default is gray). Whether the indicator should hide when not animating (true by default). Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}. Size of the indicator. Small has a height of 20, large has a height of 36. You can edit the content above on GitHub and send us a pull request! You can edit the content above on GitHub and send us a pull request! You can edit the content above on GitHub and send us a pull request! Launches an alert dialog with the specified title and message. Optionally provide a list of buttons. Tapping any button will fire the
+ 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,
@@ -13,7 +13,7 @@ of a neutral, negative and a positive button: You can edit the content above on GitHub and send us a pull request! You can edit the content above on GitHub and send us a pull request! Creating an iOS alert: An Alert button type Default alert with no inputs Plain text input alert Secure text input alert Login and password alert An Alert button style Default button style Cancel button style Destructive button style Array or buttons Button label Callback function when button pressed Button style You can edit the content above on GitHub and send us a pull request! An Alert button type Default alert with no inputs Plain text input alert Secure text input alert Login and password alert An Alert button style Default button style Cancel button style Destructive button style Array or buttons Button label Callback function when button pressed Button style You can edit the content above on GitHub and send us a pull request! 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. Assuming you have the Android SDK installed, run Make sure you have the following installed: Step 1: Set environment variables through your local shell. Note: Files may vary based on shell flavor. See below for examples from common shells. Example: 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. Assuming you have the Android SDK installed, run Make sure you have the following installed: Step 1: Set environment variables through your local shell. Note: Files may vary based on shell flavor. See below for examples from common shells. Example: Step 2: Create a Example: You can find further instructions on the official page. First, you need to install Alternatively, you can clone the repo to your Add Modify your Modify your We try our best to deliver buttery-smooth UI performance by default, but sometimes that just isn't possible. Remember, Android supports 10k+ different phones and is generalized to support software rendering: the framework architecture and need to generalize across many hardware targets unfortunately means you get less for free relative to iOS. But sometimes, there are things you can improve (and many times it's not native code's fault at all!). The first step for debugging this jank is to answer the fundamental question of where your time is being spent during each 16ms frame. For that, we'll be using a standard Android profiling tool called systrace. But first... Make sure that JS dev mode is OFF! You should see Systrace is a standard Android marker-based profiling tool (and is installed when you install the Android platform-tools package). Profiled code blocks are surrounded by markers start/end markers which are then visualized in a colorful chart format. Both the Android SDK and React Native framework provide standard markers that you can visualize. NOTE: Systrace support was added in react-native First, connect a device that exhibits the stuttering you want to investigate to your computer via USB and get it to the point right before the navigation/animation you want to profile. Run systrace as follows A quick breakdown of this command: Once the trace starts collecting, perform the animation or interaction you care about. At the end of the trace, systrace will give you a link to the trace which you can open in your browser. After opening the trace in your browser (preferably Chrome), you should see something like this: If your trace .html file isn't opening correctly, check your browser console for the following: Since Object.observe was deprecated in recent browsers, you may have to open the file from the Google Chrome Tracing tool. You can do so by: HINT: Use the WASD keys to strafe and zoom The first thing you should do is highlight the 16ms frame boundaries if you haven't already done that. Check this checkbox at the top right of the screen: You should see zebra stripes as in the screenshot above. If you don't, try profiling on a different device: Samsung has been known to have issues displaying vsyncs while the Nexus series is generally pretty reliable. Scroll until you see (part of) the name of your package. In this case, I was profiling On the left side, you'll see a set of threads which correspond to the timeline rows on the right. There are three/four threads we care about for our purposes: the UI thread (which has your package name or the name UI Thread), This is where standard android measure/layout/draw happens. The thread name on the right will be your package name (in my case book.adsmanager) or UI Thread. The events that you see on this thread should look something like this and have to do with This is where JS is executed. The thread name will be either This is where native module calls (e.g. the If you're using Android L (5.0) and up, you will also have a render thread in your application. This thread generates the actual OpenGL commands used to draw your UI. The thread name will be either A smooth animation should look something like the following: Each change in color is a frame -- remember that in order to display a frame, all our UI work needs to be done by the end of that 16ms period. Notice that no thread is working close to the frame boundary. An application rendering like this is rendering at 60FPS. If you noticed chop, however, you might see something like this: Notice that the JS thread is executing basically all the time, and across frame boundaries! This app is not rendering at 60FPS. In this case, the problem lies in JS. You might also see something like this: In this case, the UI and render threads are the ones that have work crossing frame boundaries. The UI that we're trying to render on each frame is requiring too much work to be done. In this case, the problem lies in the native views being rendered. At this point, you'll have some very helpful information to inform your next steps. If you identified a JS problem, look for clues in the specific JS that you're executing. In the scenario above, we see This doesn't seem right. Why is it being called so often? Are they actually different events? The answers to these questions will probably depend on your product code. And many times, you'll want to look into shouldComponentUpdate. TODO: Add more tools for profiling JS If you identified a native UI problem, there are usually two scenarios: In the first scenario, you'll see a trace that has the UI thread and/or Render Thread looking like this: Notice the long amount of time spent in To mitigate this, you should: If these don't help and you want to dig deeper into what the GPU is actually doing, you can check out Tracer for OpenGL ES. In the second scenario, you'll see something more like this: Notice that first the JS thread thinks for a bit, then you see some work done on the native modules thread, followed by an expensive traversal on the UI thread. There isn't an easy way to mitigate this unless you're able to postpone creating new UI until after the interaction, or you are able to simplify the UI you're creating. The react native team is working on a infrastructure level solution for this that will allow new UI to be created and configured off the main thread, allowing the interaction to continue smoothly. If you are confused or stuck, please post ask on Stack Overflow with the react-native tag. If you are unable to get a response there, or find an issue with a core component, please File a Github issue. You can edit the content above on GitHub and send us a pull request! We try our best to deliver buttery-smooth UI performance by default, but sometimes that just isn't possible. Remember, Android supports 10k+ different phones and is generalized to support software rendering: the framework architecture and need to generalize across many hardware targets unfortunately means you get less for free relative to iOS. But sometimes, there are things you can improve (and many times it's not native code's fault at all!). The first step for debugging this jank is to answer the fundamental question of where your time is being spent during each 16ms frame. For that, we'll be using a standard Android profiling tool called systrace. But first... Make sure that JS dev mode is OFF! You should see Systrace is a standard Android marker-based profiling tool (and is installed when you install the Android platform-tools package). Profiled code blocks are surrounded by markers start/end markers which are then visualized in a colorful chart format. Both the Android SDK and React Native framework provide standard markers that you can visualize. NOTE: Systrace support was added in react-native First, connect a device that exhibits the stuttering you want to investigate to your computer via USB and get it to the point right before the navigation/animation you want to profile. Run systrace as follows A quick breakdown of this command: Once the trace starts collecting, perform the animation or interaction you care about. At the end of the trace, systrace will give you a link to the trace which you can open in your browser. After opening the trace in your browser (preferably Chrome), you should see something like this: If your trace .html file isn't opening correctly, check your browser console for the following: Since Object.observe was deprecated in recent browsers, you may have to open the file from the Google Chrome Tracing tool. You can do so by: HINT: Use the WASD keys to strafe and zoom The first thing you should do is highlight the 16ms frame boundaries if you haven't already done that. Check this checkbox at the top right of the screen: You should see zebra stripes as in the screenshot above. If you don't, try profiling on a different device: Samsung has been known to have issues displaying vsyncs while the Nexus series is generally pretty reliable. Scroll until you see (part of) the name of your package. In this case, I was profiling On the left side, you'll see a set of threads which correspond to the timeline rows on the right. There are three/four threads we care about for our purposes: the UI thread (which has your package name or the name UI Thread), This is where standard android measure/layout/draw happens. The thread name on the right will be your package name (in my case book.adsmanager) or UI Thread. The events that you see on this thread should look something like this and have to do with This is where JS is executed. The thread name will be either This is where native module calls (e.g. the If you're using Android L (5.0) and up, you will also have a render thread in your application. This thread generates the actual OpenGL commands used to draw your UI. The thread name will be either A smooth animation should look something like the following: Each change in color is a frame -- remember that in order to display a frame, all our UI work needs to be done by the end of that 16ms period. Notice that no thread is working close to the frame boundary. An application rendering like this is rendering at 60FPS. If you noticed chop, however, you might see something like this: Notice that the JS thread is executing basically all the time, and across frame boundaries! This app is not rendering at 60FPS. In this case, the problem lies in JS. You might also see something like this: In this case, the UI and render threads are the ones that have work crossing frame boundaries. The UI that we're trying to render on each frame is requiring too much work to be done. In this case, the problem lies in the native views being rendered. At this point, you'll have some very helpful information to inform your next steps. If you identified a JS problem, look for clues in the specific JS that you're executing. In the scenario above, we see This doesn't seem right. Why is it being called so often? Are they actually different events? The answers to these questions will probably depend on your product code. And many times, you'll want to look into shouldComponentUpdate. TODO: Add more tools for profiling JS If you identified a native UI problem, there are usually two scenarios: In the first scenario, you'll see a trace that has the UI thread and/or Render Thread looking like this: Notice the long amount of time spent in To mitigate this, you should: If these don't help and you want to dig deeper into what the GPU is actually doing, you can check out Tracer for OpenGL ES. In the second scenario, you'll see something more like this: Notice that first the JS thread thinks for a bit, then you see some work done on the native modules thread, followed by an expensive traversal on the UI thread. There isn't an easy way to mitigate this unless you're able to postpone creating new UI until after the interaction, or you are able to simplify the UI you're creating. The react native team is working on a infrastructure level solution for this that will allow new UI to be created and configured off the main thread, allowing the interaction to continue smoothly. If you are confused or stuck, please post ask on Stack Overflow with the react-native tag. If you are unable to get a response there, or find an issue with a core component, please File a Github issue. You can edit the content above on GitHub and send us a pull request! Animations are an important part of modern UX, and the Animations are an important part of modern UX, and the The simplest workflow is to create an Fluid, meaningful animations are essential to the mobile user experience. Like
+ Fluid, meaningful animations are essential to the mobile user experience. Like
everything in React Native, Animation APIs for React Native are currently under
development, but have started to coalesce around two complementary systems:
Which would map like so: Which would map like so: Only called from native code. Starts a headless task. @param taskId the native id for this task instance to keep track of its execution
@param taskKey the key for the task to start
-@param data the data to pass to the task You can edit the content above on GitHub and send us a pull request! AppState is frequently used to determine the intent and proper behavior when
handling push notifications. It is recommended that you use an abstraction on top of On iOS, Detect hardware back button presses, and programmatically invoke the default back button
+ Detect hardware back button presses, and programmatically invoke the default back button
functionality to exit the app if there are no listeners or if none of the listeners return true. Example: A basic button component that should render nicely on any platform. Supports
+a minimal level of customization. If this button doesn't look right for your app, you can build your own
+button using TouchableOpacity
+or TouchableNativeFeedback.
+For inspiration, look at the source code for this button component.
+Or, take a look at the wide variety of button components built by the community. Example usage: You can edit the content above on GitHub and send us a pull request! Saves the photo or video to the camera roll / gallery. On Android, the tag must be a local image or video URI, such as On iOS, the tag can be any image URI (including local, remote asset-library and base64 data URIs)
+You can refer to Linking for help. Saves the photo or video to the camera roll / gallery. On Android, the tag must be a local image or video URI, such as On iOS, the tag can be any image URI (including local, remote asset-library and base64 data URIs)
or a local video file URI (remote or data URIs are not supported for saving video at this time). If the tag has a file extension of .mov or .mp4, it will be inferred as a video. Otherwise
it will be treated as a photo. To override the automatic choice, you can pass an optional
Returns a Promise which will resolve with the new URI. Returns a Promise with photo identifier objects from the local camera
@@ -19,7 +19,7 @@ const {
TouchableOpacity
} = ReactNative;
-const invariant = require('invariant');
+const invariant = require('fbjs/lib/invariant');
const CameraRollView = require('./CameraRollView');
@@ -127,7 +127,7 @@ exports.description .examples = [
{
title: 'Photos',
- render(): ReactElement<any> { return <CameraRollExample />; }
+ render(): React.Element<any> { return <CameraRollExample />; }
}
]; Get content of string type, this method returns a Get content of string type, this method returns a Set content of string type. You can use following code to set clipboard content The following formats are supported: For the named colors, React Native follows the CSS3 specification: You can edit the content above on GitHub and send us a pull request! The following formats are supported: For the named colors, React Native follows the CSS3 specification: You can edit the content above on GitHub and send us a pull request! In Integrating with Existing Apps guide and Native UI Components guide we learn how to embed React Native in a native component and vice versa. When we mix native and React Native components, we'll eventually find a need to communicate between these two worlds. Some ways to achieve that have been already mentioned in other guides. This article summarizes available techniques. React Native is inspired by React, so the basic idea of the information flow is similar. The flow in React is one-directional. We maintain a hierarchy of components, in which each component depends only on its parent and own internal state. We do this with properties: data is passed from a parent to its children in a top-down manner. If we have an ancestor component that rely on the state of its descendant, the recommended solution would be to pass down a callback that would be used by the descendant to update the ancestor. The same concept applies to React Native. As long as we are building our application purely within the framework, we can drive our app with properties and callbacks. But, when we mix React Native and native components, we need some special, cross-language mechanisms that would allow us to pass information between them. Properties are the simplest way of cross-component communication. So we need a way to pass properties both from native to React Native, and from React Native to native. In order to embed a React Native view in a native component, we use In Integrating with Existing Apps guide and Native UI Components guide we learn how to embed React Native in a native component and vice versa. When we mix native and React Native components, we'll eventually find a need to communicate between these two worlds. Some ways to achieve that have been already mentioned in other guides. This article summarizes available techniques. React Native is inspired by React, so the basic idea of the information flow is similar. The flow in React is one-directional. We maintain a hierarchy of components, in which each component depends only on its parent and own internal state. We do this with properties: data is passed from a parent to its children in a top-down manner. If we have an ancestor component that rely on the state of its descendant, the recommended solution would be to pass down a callback that would be used by the descendant to update the ancestor. The same concept applies to React Native. As long as we are building our application purely within the framework, we can drive our app with properties and callbacks. But, when we mix React Native and native components, we need some special, cross-language mechanisms that would allow us to pass information between them. Properties are the simplest way of cross-component communication. So we need a way to pass properties both from native to React Native, and from React Native to native. In order to embed a React Native view in a native component, we use Opens the standard Android date picker dialog. Opens the standard Android date picker dialog. Use Use The currently selected date. Maximum date. Restricts the range of possible date/time values. Minimum date. Restricts the range of possible date/time values. The interval at which minutes can be selected. The date picker mode. Date change handler. This is called when the user changes the date or time in the UI.
+source of truth. The currently selected date. Maximum date. Restricts the range of possible date/time values. Minimum date. Restricts the range of possible date/time values. The interval at which minutes can be selected. The date picker mode. Date change handler. This is called when the user changes the date or time in the UI.
The first and only argument is a Date object representing the new
-date and time. Timezone offset in minutes. By default, the date picker will use the device's timezone. With this
+date and time. Timezone offset in minutes. By default, the date picker will use the device's timezone. With this
parameter, it is possible to force a certain timezone offset. For
instance, to show times in Pacific Standard Time, pass -7 * 60. You can edit the content above on GitHub and send us a pull request! You can access the developer menu by shaking your device or by selecting "Shake Gesture" inside the Hardware menu in the iOS Simulator. You can also use the The Developer Menu is disabled in release (production) builds. Instead of recompiling your app every time you make a change, you can reload your app's JavaScript code instantly. To do so, select "Reload" from the Developer Menu. You can also press If the You can speed up your development times by having your app reload automatically any time your code changes. Automatic reloading can be enabled by selecting "Enable Live Reload" from the Developer Menu. You may even go a step further and keep your app running as new versions of your files are injected into the JavaScript bundle automatically by enabling Hot Reloading from the Developer Menu. This will allow you to persist the app's state through reloads. There are some instances where hot reloading cannot be implemented perfectly. If you run into any issues, use a full reload to reset your app. You will need to rebuild your app for changes to take effect in certain situations: Errors and warnings are displayed inside your app in development builds. In-app errors are displayed in a full screen alert with a red background inside your app. This screen is known as a RedBox. You can use Warnings will be displayed on screen with a yellow background. These alerts are known as YellowBoxes. Click on the alerts to show more information or to dismiss them. As with a RedBox, you can use YellowBoxes can be disabled during development by using RedBoxes and YellowBoxes are automatically disabled in release (production) builds. You can display the console logs for an iOS or Android app by using the following commands in a terminal while the app is running: You can access the developer menu by shaking your device or by selecting "Shake Gesture" inside the Hardware menu in the iOS Simulator. You can also use the The Developer Menu is disabled in release (production) builds. Instead of recompiling your app every time you make a change, you can reload your app's JavaScript code instantly. To do so, select "Reload" from the Developer Menu. You can also press If the You can speed up your development times by having your app reload automatically any time your code changes. Automatic reloading can be enabled by selecting "Enable Live Reload" from the Developer Menu. You may even go a step further and keep your app running as new versions of your files are injected into the JavaScript bundle automatically by enabling Hot Reloading from the Developer Menu. This will allow you to persist the app's state through reloads. There are some instances where hot reloading cannot be implemented perfectly. If you run into any issues, use a full reload to reset your app. You will need to rebuild your app for changes to take effect in certain situations: Errors and warnings are displayed inside your app in development builds. In-app errors are displayed in a full screen alert with a red background inside your app. This screen is known as a RedBox. You can use Warnings will be displayed on screen with a yellow background. These alerts are known as YellowBoxes. Click on the alerts to show more information or to dismiss them. As with a RedBox, you can use YellowBoxes can be disabled during development by using RedBoxes and YellowBoxes are automatically disabled in release (production) builds. You can display the console logs for an iOS or Android app by using the following commands in a terminal while the app is running: You may also access these through To debug the JavaScript code in Chrome, select "Debug JS Remotely" from the Developer Menu. This will open a new tab at http://localhost:8081/debugger-ui. Select It is currently not possible to use the "React" tab in the Chrome Developer Tools to inspect app widgets. You can use Nuclide's "React Native Inspector" as a workaround. On iOS devices, open the file On Android 5.0+ devices connected via USB, you can use the Alternatively, select "Dev Settings" from the Developer Menu, then update the "Debug server host for device" setting to match the IP address of your computer. If you run into any issues, it may be possible that one of your Chrome extensions is interacting in unexpected ways with the debugger. Try disabling all of your extensions and re-enabling them one-by-one until you find the problematic extension. To use a custom JavaScript debugger in place of Chrome Developer Tools, set the The debugger will receive a list of all project roots, separated by a space. For example, if you set Custom debugger commands executed this way should be short-lived processes, and they shouldn't produce more than 200 kilobytes of output. In In This should only be called from native code by sending the
+ This should only be called from native code by sending the
didUpdateDimensions event. @param {object} dims Simple string-keyed object of dimensions to set Initial dimensions are set before Note: Although dimensions are available immediately, they may change (e.g
due to device rotation) so any rendering logic or styles that depend on
@@ -21,6 +21,6 @@ setting a value in a Example: It is sometimes necessary to make changes directly to a component
+ It is sometimes necessary to make changes directly to a component
without using state/props to trigger a re-render of the entire subtree.
When using React in the browser for example, you sometimes need to
directly modify a DOM node, and the same is true for views in mobile
@@ -152,6 +152,6 @@ use React component that wraps the platform React component that wraps the platform Example: Specifies the lock mode of the drawer. The drawer can be locked in 3 states:
+); Specifies the lock mode of the drawer. The drawer can be locked in 3 states:
- unlocked (default), meaning that the drawer will respond (open/close) to touch gestures.
- locked-closed, meaning that the drawer will stay closed and not respond to gestures.
- locked-open, meaning that the drawer will stay opened and not respond to gestures.
-The drawer may still be opened and closed programmatically ( Specifies the side of the screen from which the drawer will slide in. Specifies the width of the drawer, more precisely the width of the view that be pulled in
-from the edge of the window. Determines whether the keyboard gets dismissed in response to a drag.
+The drawer may still be opened and closed programmatically ( Specifies the side of the screen from which the drawer will slide in. Specifies the width of the drawer, more precisely the width of the view that be pulled in
+from the edge of the window. Determines whether the keyboard gets dismissed in response to a drag.
- 'none' (the default), drags do not dismiss the keyboard.
- - 'on-drag', the keyboard is dismissed when a drag begins. Function called whenever the navigation view has been closed. Function called whenever the navigation view has been opened. Function called whenever there is an interaction with the navigation view. Function called when the drawer state has changed. The drawer can be in 3 states:
+ - 'on-drag', the keyboard is dismissed when a drag begins. Function called whenever the navigation view has been closed. Function called whenever the navigation view has been opened. Function called whenever there is an interaction with the navigation view. Function called when the drawer state has changed. The drawer can be in 3 states:
- idle, meaning there is no interaction with the navigation view happening at the time
- dragging, meaning there is currently an interaction with the navigation view
- settling, meaning that there was an interaction with the navigation view, and the
-navigation view is now finishing its closing or opening animation The navigation view that will be rendered to the side of the screen and can be pulled in. Make the drawer take the entire screen and draw the background of the
+navigation view is now finishing its closing or opening animation The navigation view that will be rendered to the side of the screen and can be pulled in. You can edit the content above on GitHub and send us a pull request! This class implements common easing functions. The math is pretty obscure,
+ This class implements common easing functions. The math is pretty obscure,
but this cool website has nice visual illustrations of what they represent:
http://xaedes.de/dev/transitions/ A simple elastic interaction, similar to a spring. Default bounciness
is 1, which overshoots a little bit once. 0 bounciness doesn't overshoot
@@ -19,6 +19,6 @@ at all, and bounciness of N > 1 will overshoot about N times. Wolfram P
apiKey: '2c98749b4a1e588efec53b2acec13025',
indexName: 'react-native-versions',
inputSelector: '#algolia-doc-search',
- algoliaOptions: { facetFilters: [ "tags:0.36" ], hitsPerPage: 5 }
+ algoliaOptions: { facetFilters: [ "tags:0.37" ], hitsPerPage: 5 }
});
\ No newline at end of file
diff --git a/docs/flexbox.html b/docs/flexbox.html
index 3701765fc62..c5a7b64e26f 100644
--- a/docs/flexbox.html
+++ b/docs/flexbox.html
@@ -1,4 +1,4 @@
- A component can specify the layout of its children using the flexbox algorithm. Flexbox is designed to provide a consistent layout on different screen sizes. You will normally use a combination of Flexbox works the same way in React Native as it does in CSS on the web, with a few exceptions. The defaults are different, with Adding A component can specify the layout of its children using the flexbox algorithm. Flexbox is designed to provide a consistent layout on different screen sizes. You will normally use a combination of Flexbox works the same way in React Native as it does in CSS on the web, with a few exceptions. The defaults are different, with Adding url points to a local file, or is a base64-encoded
@@ -180,27 +180,27 @@ exports.description .examples = [
{
title: 'Show Action Sheet',
- render(): ReactElement<any> { return <ActionSheetExample />; }
+ render(): React.Element<any> { return <ActionSheetExample />; }
},
{
title: 'Show Action Sheet with tinted buttons',
- render(): ReactElement<any> { return <ActionSheetTintExample />; }
+ render(): React.Element<any> { return <ActionSheetTintExample />; }
},
{
title: 'Show Share Action Sheet',
- render(): ReactElement<any> {
+ render(): React.Element<any> {
return <ShareActionSheetExample url="https://code.facebook.com" />;
}
},
{
title: 'Share Local Image',
- render(): ReactElement<any> {
+ render(): React.Element<any> {
return <ShareActionSheetExample url="bunny.png" />;
}
},
{
title: 'Share Screenshot',
- render(): ReactElement<any> {
+ render(): React.Element<any> {
return <ShareScreenshotExample />;
}
}
@@ -220,6 +220,6 @@ exports.examples
\ No newline at end of file
diff --git a/docs/activityindicator.html b/docs/activityindicator.html
index b9adcdb29ed..9042cb74a17 100644
--- a/docs/activityindicator.html
+++ b/docs/activityindicator.html
@@ -1,8 +1,5 @@
-ActivityIndicator #
Props #
animating PropTypes.bool #
size PropTypes.oneOfType([
- PropTypes.oneOf([ 'small', 'large' ]),
- PropTypes.number,
-]) #
ioshidesWhenStopped PropTypes.bool #
Examples #
Edit on GitHub ActivityIndicator #
Props #
animating bool #
size enum('small', 'large'), number #
ioshidesWhenStopped bool #
Examples #
Edit on GitHub ActivityIndicatorIOS #
Props #
animating PropTypes.bool #
color PropTypes.string #
hidesWhenStopped PropTypes.bool #
onLayout PropTypes.func #
size PropTypes.oneOf([
- 'small',
- 'large',
-]) #
AdSupportIOS #
Methods #
Examples #
Edit on GitHub AdSupportIOS #
Methods #
Examples #
Edit on GitHub Alert #
Alert #
Methods #
static alert(title, message?, buttons?, options?, type?) #
Examples #
Edit on GitHub Methods #
static alert(title, message?, buttons?, options?, type?) #
Examples #
Edit on GitHub AlertIOS #
AlertIOS provides functionality to create an iOS alert dialog with a
+AlertIOS #
AlertIOS provides functionality to create an iOS alert dialog with a
message or create a prompt for user input.Type Definitions #
AlertType #
$Enum
Constants:Value Description default plain-text secure-text login-password AlertButtonStyle #
$Enum
Constants:Value Description default cancel destructive ButtonsArray #
Array
Properties:Name and Type Description [text] [onPress] [style] Examples #
Edit on GitHub Type Definitions #
AlertType #
$Enum
Constants:Value Description default plain-text secure-text login-password AlertButtonStyle #
$Enum
Constants:Value Description default cancel destructive ButtonsArray #
Array
Properties:Name and Type Description [text] [onPress] [style] Examples #
Edit on GitHub Building React Native from source #
Prerequisites #
android to open the Android SDK Manager.build.gradle)build.gradle)Android Support Repository) >= 17 (for Android Support Library)Point Gradle to your Android SDK: #
.bash_profile or .bashrc.zprofile or .zshrc.profile or $ENVBuilding React Native from source #
Prerequisites #
android to open the Android SDK Manager.build.gradle)build.gradle)Android Support Repository) >= 17 (for Android Support Library)Point Gradle to your Android SDK: #
.bash_profile or .bashrc.zprofile or .zshrc.profile or $ENVlocal.properties file in the android directory of your react-native app with the following contents:Download links for Android NDK #
Building the source #
1. Installing the fork #
react-native from your fork. For example, to install the master branch from the official repo, run the following:node_modules directory and run npm install inside the cloned repo.2. Adding gradle dependencies #
gradle-download-task as dependency in android/build.gradle:android/app/build.gradle to use the :ReactAndroid project instead of the pre-compiled library, e.g. - replace compile 'com.facebook.react:react-native:0.16.+' with compile project(':ReactAndroid'):android/app/build.gradle to use the :ReactAndroid project instead of the pre-compiled library, e.g. - replace compile 'com.facebook.react:react-native:+' with compile project(':ReactAndroid'):Profiling Android UI Performance #
__DEV__ === false, development-level warning are OFF, performance optimizations are ON in your application logs (which you can view using adb logcat)Profiling with Systrace #
Collecting a trace #
v0.15. You will need to build with that version to collect a trace.time is the length of time the trace will be collected in secondssched, gfx, and view are the android SDK tags (collections of markers) we care about: sched gives you information about what's running on each core of your phone, gfx gives you graphics info such as frame boundaries, and view gives you information about measure, layout, and draw passes-a <your_package_name> enables app-specific markers, specifically the ones built into the React Native framework. your_package_name can be found in the AndroidManifest.xml of your app and looks like com.example.appReading the trace #
Enable VSync highlighting #
Find your process #
com.facebook.adsmanager, which shows up as book.adsmanager because of silly thread name limits in the kernel.mqt_js and mqt_native_modules. If you're running on Android 5+, we also care about the Render Thread.UI Thread #
Choreographer, traversals, and DispatchUI:
JS Thread #
mqt_js or <...> depending on how cooperative the kernel on your device is being. To identify it if it doesn't have a name, look for things like JSCall, Bridge.executeJSCall, etc:
Native Modules Thread #
UIManager) are executed. The thread name will be either mqt_native_modules or <...>. To identify it in the latter case, look for things like NativeCall, callJavaModuleMethod, and onBatchComplete:
Bonus: Render Thread #
RenderThread or <...>. To identify it in the latter case, look for things like DrawFrame and queueBuffer:
Identifying a culprit #
JS Issues #
RCTEventEmitter being called multiple times per frame. Here's a zoom-in of the JS thread from the trace above:
Native UI Issues #
Too much GPU work #
DrawFrame that crosses frame boundaries. This is time spent waiting for the GPU to drain its command buffer from the previous frame.renderToHardwareTextureAndroid for complex, static content that is being animated/transformed (e.g. the Navigator slide/alpha animations)needsOffscreenAlphaCompositing, which is disabled by default, as it greatly increases the per-frame load on the GPU in most cases.Creating new views on the UI thread #
Still stuck? #
Profiling Android UI Performance #
__DEV__ === false, development-level warning are OFF, performance optimizations are ON in your application logs (which you can view using adb logcat)Profiling with Systrace #
Collecting a trace #
v0.15. You will need to build with that version to collect a trace.time is the length of time the trace will be collected in secondssched, gfx, and view are the android SDK tags (collections of markers) we care about: sched gives you information about what's running on each core of your phone, gfx gives you graphics info such as frame boundaries, and view gives you information about measure, layout, and draw passes-a <your_package_name> enables app-specific markers, specifically the ones built into the React Native framework. your_package_name can be found in the AndroidManifest.xml of your app and looks like com.example.appReading the trace #
Enable VSync highlighting #
Find your process #
com.facebook.adsmanager, which shows up as book.adsmanager because of silly thread name limits in the kernel.mqt_js and mqt_native_modules. If you're running on Android 5+, we also care about the Render Thread.UI Thread #
Choreographer, traversals, and DispatchUI:JS Thread #
mqt_js or <...> depending on how cooperative the kernel on your device is being. To identify it if it doesn't have a name, look for things like JSCall, Bridge.executeJSCall, etc:Native Modules Thread #
UIManager) are executed. The thread name will be either mqt_native_modules or <...>. To identify it in the latter case, look for things like NativeCall, callJavaModuleMethod, and onBatchComplete:Bonus: Render Thread #
RenderThread or <...>. To identify it in the latter case, look for things like DrawFrame and queueBuffer:Identifying a culprit #
JS Issues #
RCTEventEmitter being called multiple times per frame. Here's a zoom-in of the JS thread from the trace above:Native UI Issues #
Too much GPU work #
DrawFrame that crosses frame boundaries. This is time spent waiting for the GPU to drain its command buffer from the previous frame.renderToHardwareTextureAndroid for complex, static content that is being animated/transformed (e.g. the Navigator slide/alpha animations)needsOffscreenAlphaCompositing, which is disabled by default, as it greatly increases the per-frame load on the GPU in most cases.Creating new views on the UI thread #
Still stuck? #
Animated #
Animated
+Animated #
Animated
library is designed to make them fluid, powerful, and easy to build and
maintain.Animated.Value, hook it up to one or
more style attributes of an animated component, and then drive updates either
@@ -366,6 +366,6 @@ exports.examples
\ No newline at end of file
diff --git a/docs/animations.html b/docs/animations.html
index f90bf2935a6..d1a081cdfef 100644
--- a/docs/animations.html
+++ b/docs/animations.html
@@ -1,4 +1,4 @@
-Animations #
Animations #
LayoutAnimation for animated global layout transactions, and Animated for
@@ -85,7 +85,10 @@ back down to zero at 100 followed by a dead-zone that remains at 0 for
everything beyond that, you could do:Input Output -400 450 -300 300 -200 150 -100 0 -50 0.5 0 1 50 0.5 100 0 101 0 200 0 interpolation also supports arbitrary easing functions, many of which are
+});Input Output -400 450 -300 300 -200 150 -100 0 -50 0.5 0 1 50 0.5 100 0 101 0 200 0 interpolate also supports mapping to strings, allowing you to animate colors as well as values with units. For example, if you wanted to animate a rotation you could do:interpolation also supports arbitrary easing functions, many of which are
already implemented in the
Easing
class including quadratic, exponential, and bezier curves as well as functions
@@ -391,6 +394,6 @@ source.AppRegistry #
AppRegistry is the JS entry point to running all React Native apps. App
+AppRegistry #
AppRegistry is the JS entry point to running all React Native apps. App
root components should register themselves with
AppRegistry.registerComponent, then the native system can load the bundle
for the app and then actually run the app when it's ready by invoking
@@ -12,7 +12,7 @@ sure the JS execution environment is setup before other modules are
the only argument; when the promise is resolved or rejected the native side is
notified of this event and it may decide to destroy the JS context.static startHeadlessTask(taskId, taskKey, data) #
AppState #
AppState can tell you if the app is in the foreground or background,
+AppState #
AppState can tell you if the app is in the foreground or background,
and notify you when the state changes.App States #
active - The app is running in the foregroundbackground - The app is running in the background. The user is either
in another app or on the home screeninactive - This is a state that occurs when transitioning between
@@ -105,17 +105,17 @@ exports.examples {
title: 'Subscribed AppState:',
description: 'This changes according to the current state, so you can only ever see it rendered as "active"',
- render(): ReactElement<any> { return <AppStateSubscription showCurrentOnly={true} />; }
+ render(): React.Element<any> { return <AppStateSubscription showCurrentOnly={true} />; }
},
{
title: 'Previous states:',
- render(): ReactElement<any> { return <AppStateSubscription showCurrentOnly={false} />; }
+ render(): React.Element<any> { return <AppStateSubscription showCurrentOnly={false} />; }
},
{
platform: 'ios',
title: 'Memory Warnings',
description: 'In the IOS simulator, hit Shift+Command+M to simulate a memory warning.',
- render(): ReactElement<any> { return <AppStateSubscription showMemoryWarnings={true} />; }
+ render(): React.Element<any> { return <AppStateSubscription showMemoryWarnings={true} />; }
},
];AsyncStorage #
AsyncStorage is a simple, unencrypted, asynchronous, persistent, key-value storage
+AsyncStorage #
AsyncStorage is a simple, unencrypted, asynchronous, persistent, key-value storage
system that is global to the app. It should be used instead of LocalStorage.AsyncStorage
instead of AsyncStorage directly for anything more than light usage since
it operates globally.AsyncStorage is backed by native code that stores small values in a
@@ -215,7 +215,7 @@ exports.description .examples = [
{
title: 'Basics - getItem, setItem, removeItem',
- render(): ReactElement<any> { return <BasicStorageExample />; }
+ render(): React.Element<any> { return <BasicStorageExample />; }
},
];BackAndroid #
BackAndroid #
Button #
Props #
Examples #
Edit on GitHub CameraRoll #
CameraRoll provides access to the local camera roll / gallery.
+CameraRoll #
CameraRoll provides access to the local camera roll / gallery.
Before using this you must link the RCTCameraRoll library.
-You can refer to (Linking)[https://facebook.github.io/react-native/docs/linking-libraries-ios.html] for help.Methods #
static saveImageWithTag(tag) #
static saveToCameraRoll(tag, type?) #
"file:///sdcard/img.png".Methods #
static saveImageWithTag(tag) #
static saveToCameraRoll(tag, type?) #
"file:///sdcard/img.png".type parameter that must be one of 'photo' or 'video'.static getPhotos(params) #
Clipboard #
Clipboard gives you an interface for setting and getting content from Clipboard on both iOS and AndroidMethods #
static getString(0) #
Promise, so you can use following code to get clipboard contentClipboard #
Clipboard gives you an interface for setting and getting content from Clipboard on both iOS and AndroidMethods #
static getString(0) #
Promise, so you can use following code to get clipboard contentstatic setString(content) #
Colors #
'#f0f' (#rgb)'#f0fc' (#rgba)'#ff00ff' (#rrggbb)'#ff00ff00' (#rrggbbaa)'rgb(255, 255, 255)''rgba(255, 255, 255, 1.0)''hsl(360, 100%, 100%)''hsla(360, 100%, 100%, 1.0)''transparent''red'0xff00ff00 (0xrrggbbaa)Colors #
'#f0f' (#rgb)'#f0fc' (#rgba)'#ff00ff' (#rrggbb)'#ff00ff00' (#rrggbbaa)'rgb(255, 255, 255)''rgba(255, 255, 255, 1.0)''hsl(360, 100%, 100%)''hsla(360, 100%, 100%, 1.0)''transparent''red'0xff00ff00 (0xrrggbbaa)Communication between native and React Native #
Introduction #
Properties #
Passing properties from native to React Native #
RCTRootView. RCTRootView is a UIView that holds a React Native app. It also provides an interface between native side and the hosted app.RCTRootView has an initializer that allows you to pass arbitrary properties down to the React Native app. The initialProperties parameter has to be an instance of NSDictionary. The dictionary is internally converted into a JSON object that the top-level JS component can reference.Communication between native and React Native #
Introduction #
Properties #
Passing properties from native to React Native #
RCTRootView. RCTRootView is a UIView that holds a React Native app. It also provides an interface between native side and the hosted app.RCTRootView has an initializer that allows you to pass arbitrary properties down to the React Native app. The initialProperties parameter has to be an instance of NSDictionary. The dictionary is internally converted into a JSON object that the top-level JS component can reference.DatePickerAndroid #
Example #
DatePickerAndroid #
Example #
DatePickerIOS #
DatePickerIOS to render a date/time picker (selector) on iOS. This is
+DatePickerIOS #
DatePickerIOS to render a date/time picker (selector) on iOS. This is
a controlled component, so you must hook in to the onDateChange callback
and update the date prop in order for the component to update, otherwise
the user's change will be reverted immediately to reflect props.date as the
-source of truth.Props #
date PropTypes.instanceOf(Date).isRequired #
maximumDate PropTypes.instanceOf(Date) #
minimumDate PropTypes.instanceOf(Date) #
minuteInterval PropTypes.oneOf([1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30]) #
mode PropTypes.oneOf(['date', 'time', 'datetime']) #
onDateChange PropTypes.func.isRequired #
Props #
date Date #
maximumDate Date #
minimumDate Date #
minuteInterval enum(1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30) #
mode enum('date', 'time', 'datetime') #
onDateChange function #
timeZoneOffsetInMinutes PropTypes.number #
timeZoneOffsetInMinutes number #
Examples #
Edit on GitHub Debugging #
Accessing the In-App Developer Menu #
Command⌘ + D keyboard shortcut when your app is running in the iPhone Simulator, or Command⌘ + M when running in an Android emulator.
Reloading JavaScript #
Command⌘ + R in the iOS Simulator, or press R twice on Android emulators.Command⌘ + R keyboard shortcut does not seem to reload the iOS Simulator, go to the Hardware menu, select Keyboard, and make sure that "Connect Hardware Keyboard" is checked.Automatic reloading #
Images.xcassets on iOS or the res/drawable folder on Android.In-app Errors and Warnings #
Errors #
console.error() to manually trigger one.Warnings #
console.warn() to trigger a YellowBox.console.disableYellowBox = true;. Specific warnings can be ignored programmatically by setting an array of prefixes that should be ignored: console.ignoredYellowBox = ['Warning: ...'];Accessing console logs #
Debugging #
Accessing the In-App Developer Menu #
Command⌘ + D keyboard shortcut when your app is running in the iPhone Simulator, or Command⌘ + M when running in an Android emulator.Reloading JavaScript #
Command⌘ + R in the iOS Simulator, or press R twice on Android emulators.Command⌘ + R keyboard shortcut does not seem to reload the iOS Simulator, go to the Hardware menu, select Keyboard, and make sure that "Connect Hardware Keyboard" is checked.Automatic reloading #
Images.xcassets on iOS or the res/drawable folder on Android.In-app Errors and Warnings #
Errors #
console.error() to manually trigger one.Warnings #
console.warn() to trigger a YellowBox.console.disableYellowBox = true;. Specific warnings can be ignored programmatically by setting an array of prefixes that should be ignored: console.ignoredYellowBox = ['Warning: ...'];Accessing console logs #
Debug → Open System Log... in the iOS Simulator or by running adb logcat *:S ReactNative:V ReactNativeJS:V in a terminal while an Android app is running on a device or emulator.Chrome Developer Tools #
Tools → Developer Tools from the Chrome Menu to open the Developer Tools. You may also access the DevTools using keyboard shortcuts (Command⌘ + Option⌥ + I on Mac, Ctrl + Shift + I on Windows). You may also want to enable Pause On Caught Exceptions for a better debugging experience.Debugging on a device with Chrome Developer Tools #
RCTWebSocketExecutor.m and change "localhost" to the IP address of your computer, then select "Debug JS Remotely" from the Developer Menu.adb command line tool to setup port forwarding from the device to your computer:adb reverse tcp:8081 tcp:8081Debugging using a custom JavaScript debugger #
REACT_DEBUGGER environment variable to a command that will start your custom debugger. You can then select "Debug JS Remotely" from the Developer Menu to start debugging.REACT_DEBUGGER="node /path/to/launchDebugger.js --port 2345 --type ReactNative", then the command node /path/to/launchDebugger.js --port 2345 --type ReactNative /path/to/reactNative/app will be used to start your debugger.Debugging with Stetho on Android #
android/app/build.gradle, add these lines in the dependencies section:android/app/src/main/java/com/{yourAppName}/MainApplication.java, add the following imports: Dimensions #
Methods #
static set(dims) #
Dimensions #
Methods #
static set(dims) #
static get(dim) #
runApplication is called so they should
be available before any other require's are run, but may be updated later.StyleSheet).var {height,
apiKey: '2c98749b4a1e588efec53b2acec13025',
indexName: 'react-native-versions',
inputSelector: '#algolia-doc-search',
- algoliaOptions: { facetFilters: [ "tags:0.36" ], hitsPerPage: 5 }
+ algoliaOptions: { facetFilters: [ "tags:0.37" ], hitsPerPage: 5 }
});
\ No newline at end of file
diff --git a/docs/direct-manipulation.html b/docs/direct-manipulation.html
index 6f32f1943e2..adf60353235 100644
--- a/docs/direct-manipulation.html
+++ b/docs/direct-manipulation.html
@@ -1,4 +1,4 @@
-Direct Manipulation #
Direct Manipulation #
setState instead of setNativeProps.DrawerLayoutAndroid #
DrawerLayout (Android only). The
+DrawerLayoutAndroid #
DrawerLayout (Android only). The
Drawer (typically used for navigation) is rendered with renderNavigationView
and direct children are the main view (where your content goes). The navigation
view is initially not visible on the screen, but can be pulled in from the
@@ -24,28 +24,18 @@ be set by the drawerWidth prop.drawerLockMode ReactPropTypes.oneOf([
- 'unlocked',
- 'locked-closed',
- 'locked-open'
-]) #
drawerLockMode enum('unlocked', 'locked-closed', 'locked-open') #
openDrawer/closeDrawer).drawerPosition ReactPropTypes.oneOf([
- DrawerConsts.DrawerPosition.Left,
- DrawerConsts.DrawerPosition.Right
-]) #
drawerWidth ReactPropTypes.number #
keyboardDismissMode ReactPropTypes.oneOf([
- 'none', // default
- 'on-drag',
-]) #
openDrawer/closeDrawer).drawerPosition enum(DrawerConsts.DrawerPosition.Left, DrawerConsts.DrawerPosition.Right) #
drawerWidth number #
keyboardDismissMode enum('none', 'on-drag') #
onDrawerClose ReactPropTypes.func #
onDrawerOpen ReactPropTypes.func #
onDrawerSlide ReactPropTypes.func #
onDrawerStateChanged ReactPropTypes.func #
onDrawerClose function #
onDrawerOpen function #
onDrawerSlide function #
onDrawerStateChanged function #
renderNavigationView ReactPropTypes.func.isRequired #
statusBarBackgroundColor color #
renderNavigationView function #
Methods #
Easing #
Easing #
Methods #
static step0(n) #
static step1(n) #
static linear(t) #
static ease(t) #
static quad(t) #
static cubic(t) #
static poly(n) #
static sin(t) #
static circle(t) #
static exp(t) #
static elastic(bounciness) #
Layout with Flexbox #
flexDirection, alignItems, and justifyContent to achieve the right layout.flexDirection defaulting to column instead of row, and alignItems defaulting to stretch instead of flex-start, and the flex parameter only supports a single number.Flex Direction #
flexDirection to a component's style determines the primary axis of its layout. Should the children be organized horizontally (row) or vertically (column)? The default is column.Layout with Flexbox #
flexDirection, alignItems, and justifyContent to achieve the right layout.flexDirection defaulting to column instead of row, and alignItems defaulting to stretch instead of flex-start, and the flex parameter only supports a single number.Flex Direction #
flexDirection to a component's style determines the primary axis of its layout. Should the children be organized horizontally (row) or vertically (column)? The default is column.
