React NativeNative iOS Components
With React Native, you can use the platform components such as iOS UITabBar and UINavigationController.
Native iOS Components
With React Native, you can use the standard platform components such as UITabBar and UINavigationController on iOS. This gives your app a consistent look and feel with the rest of the platform ecosystem, and keeps the quality bar high. These components are easily incorporated into your app using their React component counterparts, such as TabBarIOS and NavigatorIOS.
Async
Decoding images off of the main thread... Asynchronous bridge, Chrome Dev Tools...
Touch Handling
iOS has a very powerful system called Responder to handle touches which the web lacks. React Native implements iOS responder system and provides high level components such as TouchableHighlight that work well right off the bat.
Asynchronous
All operations between the JavaScript application code and the native platform are performed asynchronously, and the native modules can also make use of additional threads as well. This means we can decode images off of the main thread, save to disk in the background, measure text and compute layouts without blocking the UI, and more. As a result, React Native apps are naturally fluid and responsive. The communication is also fully serializable, which allows us to leverage Chrome Developer Tools to debug JS while running the app in the full app environment, in the sim or on a real device.
Touch Handling
iOS has a very powerful system called the Responder Chain to negotiate touches in complex view hierarchies which does not have a universal analog on the web. React Native implements a similar responder system and provides high level components such as TouchableHighlight that integrate properly with scroll views and other elements without any additional configutation.
Flexbox
Laying out views should be easy
Flexbox and Styling
Laying out views should be easy, which is why we brought the flexbox layout model from the web to React Native. Flexbox makes it easy to build the most common UI layouts, such as stacked and nested boxes with margin and padding. React Native also supports common web syles, such as fontWeight, and the StyleSheet abstraction makes it easy to declare all your styles and layout right along with the components that use them and used inline.
Polyfills
React Native attempts to innovate on the view layer, for the rest, it polyfills web standards. You can use npm to install JavaScript dependencies, XMLHttpRequest, requestAnimationFrame, navigator.geolocation...
AlertIOS
AlertIOS manages native iOS alerts, option sheets, and share dialogs
Methods #
static alert(title: string, message?: string, buttons?: Array<{
+React Native | Build Native Apps Using React Animation
All rights reserved.
This source code is licensed under the BSD-style license found in the
+
React Native | Build Native Apps Using React Animation
All rights reserved.
This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
AppRegistry
AppRegistry is the JS entry point to running all React Native apps. App
+
React Native | Build Native Apps Using React 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
diff --git a/docs/appstateios.html b/docs/appstateios.html
index a0826c8d742..01bfde6d185 100644
--- a/docs/appstateios.html
+++ b/docs/appstateios.html
@@ -1,6 +1,32 @@
-
React Native | Build Native Apps Using React AppStateIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the
-LICENSE file in the root directory of this source tree. An additional grant
-of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
AppStateIOS
AppStateIOS can tell you if the app is in the foreground or background,
+and notify you when the state changes.
AppStateIOS is frequently used to determine the intent and proper behavior when
+handling push notifications.
iOS 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 transition state that currently never happens for
+ typical React Native apps.
For more information, see
+Apple's documentation
Basic Usage #
To see the current state, you can check AppStateIOS.currentState, which
+will be kept up-to-date. However, currentState will be null at launch
+while AppStateIOS retrieves it over the bridge.
getInitialState: function() {
+ return {
+ currentAppState: AppStateIOS.currentState,
+ };
+},
+componentDidMount: function() {
+ AppStateIOS.addEventListener('change', this._handleAppStateChange);
+},
+componentWillUnmount: function() {
+ AppStateIOS.removeEventListener('change', this._handleAppStateChange);
+},
+_handleAppStateChange: function(currentAppState) {
+ this.setState({ currentAppState, });
+},
+render: function() {
+ return (
+ <Text>Current state is: {this.state.currentAppState}</Text>
+ );
+},This example will only ever appear to say "Current state is: active" because
+the app is only visible to the user when in the active state, and the null
+state will happen only momentarily.
Methods #
AsyncStorage
AsyncStorage is a simple, asynchronous, persistent, global, key-value storage
+
React Native | Build Native Apps Using React AsyncStorage
AsyncStorage is a simple, asynchronous, persistent, global, key-value storage
system. It should be used instead of LocalStorage.
It is recommended that you use an abstraction on top of AsyncStorage instead
of AsyncStorage directly for anything more than light usage since it
operates globally.
This JS code is a simple facad over the native iOS implementation to provide
diff --git a/docs/cameraroll.html b/docs/cameraroll.html
index 6f9ee7715db..c737e2857b2 100644
--- a/docs/cameraroll.html
+++ b/docs/cameraroll.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React CameraRoll
All rights reserved.
This source code is licensed under the BSD-style license found in the
+
React Native | Build Native Apps Using React CameraRoll
All rights reserved.
This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
static saveImageWithTag(tag: string, successCallback, errorCallback) #
Saves the image with tag tag to the camera roll.
@param {string} tag - Can be any of the three kinds of tags we accept:
1. URL
diff --git a/docs/datepickerios.html b/docs/datepickerios.html
index 983d1485378..ac8f556f0a4 100644
--- a/docs/datepickerios.html
+++ b/docs/datepickerios.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React DatePickerIOS
Use DatePickerIOS to render a date/time picker (selector) on iOS. This is
+
React Native | Build Native Apps Using React DatePickerIOS
Use 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
diff --git a/docs/flexbox.html b/docs/flexbox.html
index 1bdb991eb58..7bcffcdd288 100644
--- a/docs/flexbox.html
+++ b/docs/flexbox.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React Flexbox
Props #
alignItems enum('flex-start', 'flex-end', 'center', 'stretch') #
alignSelf enum('auto', 'flex-start', 'flex-end', 'center', 'stretch') #
borderBottomWidth number #
borderLeftWidth number #
borderRightWidth number #
borderTopWidth number #
borderWidth number #
bottom number #
flex number #
flexDirection enum('row', 'column') #
flexWrap enum('wrap', 'nowrap') #
height number #
justifyContent enum('flex-start', 'flex-end', 'center', 'space-between', 'space-around') #
left number #
margin number #
marginBottom number #
marginHorizontal number #
marginLeft number #
marginRight number #
marginTop number #
marginVertical number #
padding number #
paddingBottom number #
paddingHorizontal number #
paddingLeft number #
paddingRight number #
paddingTop number #
paddingVertical number #
position enum('absolute', 'relative') #
right number #
top number #
width number #
Flexbox
Props #
alignItems enum('flex-start', 'flex-end', 'center', 'stretch') #
alignSelf enum('auto', 'flex-start', 'flex-end', 'center', 'stretch') #
borderBottomWidth number #
borderLeftWidth number #
borderRightWidth number #
borderTopWidth number #
borderWidth number #
bottom number #
flex number #
flexDirection enum('row', 'column') #
flexWrap enum('wrap', 'nowrap') #
height number #
justifyContent enum('flex-start', 'flex-end', 'center', 'space-between', 'space-around') #
left number #
margin number #
marginBottom number #
marginHorizontal number #
marginLeft number #
marginRight number #
marginTop number #
marginVertical number #
padding number #
paddingBottom number #
paddingHorizontal number #
paddingLeft number #
paddingRight number #
paddingTop number #
paddingVertical number #
position enum('absolute', 'relative') #
right number #
top number #
width number #
Geolocation
/!\ ATTENTION /!\
+
React Native | Build Native Apps Using React Geolocation
/!\ ATTENTION /!\
You need to add NSLocationWhenInUseUsageDescription key
in Info.plist to enable geolocation, otherwise it's going
to fail silently!
diff --git a/docs/gesture-responder-system.html b/docs/gesture-responder-system.html
index cca37ea56a3..010ed653aa4 100644
--- a/docs/gesture-responder-system.html
+++ b/docs/gesture-responder-system.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React Gesture Responder System
Gesture recognition on mobile devices is much more complicated than web. A touch can go through several phases as the app determines what the user's intention is. For example, the app needs to determine if the touch is scrolling, sliding on a widget, or tapping. This can even change during the duration of a touch. There can also be multiple simultaneous touches.
The touch responder system is needed to allow components to negotiate these touch interactions without any additional knowledge about their parent or child components. This system is implemented in ResponderEventPlugin.js, which contains further details and documentation.
Best Practices #
Users can feel huge differences in the usability of web apps vs. native, and this is one of the big causes. Every action should have the following attributes:
- Feedback/highlighting- show the user what is handling their touch, and what will happen when they release the gesture
- Cancel-ability- when making an action, the user should be able to abort it mid-touch by dragging their finger away
These features make users more comfortable while using an app, because it allows people to experiment and interact without fear of making mistakes.
TouchableHighlight and Touchable* #
The responder system can be complicated to use. So we have provided an abstract Touchable implementation for things that should be "tappable". This uses the responder system and allows you to easily configure tap interactions declaratively. Use TouchableHighlight anywhere where you would use a button or link on web.
Responder Lifecycle #
A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder:
View.props.onStartShouldSetResponder: (evt) => true, - Does this view want to become responder on the start of a touch?View.props.onMoveShouldSetResponder: (evt) => true, - Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
If the View returns true and attempts to become the responder, one of the following will happen:
View.props.onResponderGrant: (evt) => {} - The View is now responding for touch events. This is the time to highlight and show the user what is happeningView.props.onResponderReject: (evt) => {} - Something else is the responder right now and will not release it
If the view is responding, the following handlers can be called:
View.props.onResponderMove: (moveEvt) => {} - The user is moving their fingerView.props.onResponderRelease: (releaseEvt) => {} - Fired at the end of the touch, ie "touchUp"View.props.onResponderTerminationRequest: (evt) => true - Something else wants to become responder. Should this view release the responder? Returning true allows releaseView.props.onResponderTerminate: (evt) => {} - The responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)
Capture ShouldSet Handlers #
onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
View.props.onStartShouldSetResponderCapture: (evt) => true,View.props.onMoveShouldSetResponderCapture: (evt) => true,
PanResponder #
For higher-level gesture interpretation, check out PanResponder.
Gesture Responder System
Gesture recognition on mobile devices is much more complicated than web. A touch can go through several phases as the app determines what the user's intention is. For example, the app needs to determine if the touch is scrolling, sliding on a widget, or tapping. This can even change during the duration of a touch. There can also be multiple simultaneous touches.
The touch responder system is needed to allow components to negotiate these touch interactions without any additional knowledge about their parent or child components. This system is implemented in ResponderEventPlugin.js, which contains further details and documentation.
Best Practices #
Users can feel huge differences in the usability of web apps vs. native, and this is one of the big causes. Every action should have the following attributes:
- Feedback/highlighting- show the user what is handling their touch, and what will happen when they release the gesture
- Cancel-ability- when making an action, the user should be able to abort it mid-touch by dragging their finger away
These features make users more comfortable while using an app, because it allows people to experiment and interact without fear of making mistakes.
TouchableHighlight and Touchable* #
The responder system can be complicated to use. So we have provided an abstract Touchable implementation for things that should be "tappable". This uses the responder system and allows you to easily configure tap interactions declaratively. Use TouchableHighlight anywhere where you would use a button or link on web.
Responder Lifecycle #
A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder:
View.props.onStartShouldSetResponder: (evt) => true, - Does this view want to become responder on the start of a touch?View.props.onMoveShouldSetResponder: (evt) => true, - Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
If the View returns true and attempts to become the responder, one of the following will happen:
View.props.onResponderGrant: (evt) => {} - The View is now responding for touch events. This is the time to highlight and show the user what is happeningView.props.onResponderReject: (evt) => {} - Something else is the responder right now and will not release it
If the view is responding, the following handlers can be called:
View.props.onResponderMove: (moveEvt) => {} - The user is moving their fingerView.props.onResponderRelease: (releaseEvt) => {} - Fired at the end of the touch, ie "touchUp"View.props.onResponderTerminationRequest: (evt) => true - Something else wants to become responder. Should this view release the responder? Returning true allows releaseView.props.onResponderTerminate: (evt) => {} - The responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)
Capture ShouldSet Handlers #
onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
View.props.onStartShouldSetResponderCapture: (evt) => true,View.props.onMoveShouldSetResponderCapture: (evt) => true,
PanResponder #
For higher-level gesture interpretation, check out PanResponder.
Getting Started
Requirements #
- OS X - This repo only contains the iOS implementation right now, and Xcode only runs on Mac.
- New to Xcode? Download it from the Mac App Store.
- Homebrew is the recommended way to install node, watchman, and flow.
brew install node. New to node or npm?brew install watchman. We recommend installing watchman, otherwise you might hit a node file watching bug.brew install flow. If you want to use flow.
Quick start #
npm install -g react-native-clireact-native init AwesomeProject
In the newly created folder AwesomeProject/
- Open
AwesomeProject.xcodeproj and hit run in Xcode - Open
index.ios.js in your text editor of choice and edit some lines - Hit cmd+R (twice) in your iOS simulator to reload the app and see your change!
Congratulations! You've just successfully run and modified your first React Native app.
Getting Started
Requirements #
- OS X - This repo only contains the iOS implementation right now, and Xcode only runs on Mac.
- New to Xcode? Download it from the Mac App Store.
- Homebrew is the recommended way to install node, watchman, and flow.
brew install node. New to node or npm?brew install watchman. We recommend installing watchman, otherwise you might hit a node file watching bug.brew install flow. If you want to use flow.
Quick start #
npm install -g react-native-clireact-native init AwesomeProject
In the newly created folder AwesomeProject/
- Open
AwesomeProject.xcodeproj and hit run in Xcode - Open
index.ios.js in your text editor of choice and edit some lines - Hit cmd+R (twice) in your iOS simulator to reload the app and see your change!
Congratulations! You've just successfully run and modified your first React Native app.
Image
A react component for displaying different types of images,
+
React Native | Build Native Apps Using React Image
A react component for displaying different types of images,
including network images, static resources, temporary local images, and
images from local disk, such as the camera roll.
Example usage:
renderImages: function() {
return (
diff --git a/docs/interactionmanager.html b/docs/interactionmanager.html
index 01222fda3a6..1764210fd9f 100644
--- a/docs/interactionmanager.html
+++ b/docs/interactionmanager.html
@@ -1,4 +1,4 @@
-React Native | Build Native Apps Using React InteractionManager
InteractionManager allows long-running work to be scheduled after any
+
React Native | Build Native Apps Using React InteractionManager
InteractionManager allows long-running work to be scheduled after any
interactions/animations have completed. In particular, this allows JavaScript
animations to run smoothly.
Applications can schedule tasks to run after interactions with the following:
InteractionManager.runAfterInteractions(() => {
// ...long-running synchronous task...
diff --git a/docs/layoutanimation.html b/docs/layoutanimation.html
index e9e03866767..c0027ebb856 100644
--- a/docs/layoutanimation.html
+++ b/docs/layoutanimation.html
@@ -1,4 +1,4 @@
-React Native | Build Native Apps Using React LayoutAnimation
All rights reserved.
This source code is licensed under the BSD-style license found in the
+
React Native | Build Native Apps Using React LayoutAnimation
All rights reserved.
This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
ListView
ListView - A core component designed for efficient display of vertically
+
React Native | Build Native Apps Using React ListView
ListView - A core component designed for efficient display of vertically
scrolling lists of changing data. The minimal API is to create a
ListView.DataSource, populate it with a simple array of data blobs, and
instantiate a ListView component with that data source and a renderRow
diff --git a/docs/mapview.html b/docs/mapview.html
index a42ec5abea3..5f4585d045f 100644
--- a/docs/mapview.html
+++ b/docs/mapview.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React MapView
Props #
legalLabelInsets {top: number, left: number, bottom: number, right: number} #
Insets for the map's legal label, originally at bottom left of the map.
+
React Native | Build Native Apps Using React MapView
Props #
legalLabelInsets {top: number, left: number, bottom: number, right: number} #
Insets for the map's legal label, originally at bottom left of the map.
See EdgeInsetsPropType.js for more information.
maxDelta number #
Maximum size of area that can be displayed.
minDelta number #
Minimum size of area that can be displayed.
onRegionChange function #
Callback that is called continuously when the user is dragging the map.
onRegionChangeComplete function #
Callback that is called once, when the user is done moving the map.
pitchEnabled bool #
When this property is set to true and a valid camera is associated
with the map, the camera’s pitch angle is used to tilt the plane
of the map. When this property is set to false, the camera’s pitch
diff --git a/docs/nativemodulesios.html b/docs/nativemodulesios.html
index 926de3bd9ce..6eee1bc2115 100644
--- a/docs/nativemodulesios.html
+++ b/docs/nativemodulesios.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React Native Modules (iOS)
Sometimes an app needs access to platform API, and React Native doesn't have a corresponding wrapper yet. Maybe you want to reuse some existing Objective-C or C++ code without having to reimplement it in JavaScript. Or write some high performance, multi-threaded code such as image processing, network stack, database or rendering.
We designed React Native such that it is possible for you to write real native code and have access to the full power of the platform. This is a more advanced feature and we don't expect it to be part of the usual development process, however it is essential that it exists. If React Native doesn't support a native feature that you need, you should be able to build it yourself.
This is a more advanced guide that shows how to build a native module. It assumes the reader knows Objective-C (Swift is not supported yet) and core libraries (Foundation, UIKit).
iOS Calendar module example #
This guide will use iOS Calendar API example. Let's say we would like to be able to access iOS calendar from JavaScript.
Native module is just an Objectve-C class that implements RCTBridgeModule protocol. If you are wondering, RCT is a shorthand for ReaCT.
// CalendarManager.h
+React Native | Build Native Apps Using React Native Modules (iOS)
Sometimes an app needs access to platform API, and React Native doesn't have a corresponding wrapper yet. Maybe you want to reuse some existing Objective-C or C++ code without having to reimplement it in JavaScript. Or write some high performance, multi-threaded code such as image processing, network stack, database or rendering.
We designed React Native such that it is possible for you to write real native code and have access to the full power of the platform. This is a more advanced feature and we don't expect it to be part of the usual development process, however it is essential that it exists. If React Native doesn't support a native feature that you need, you should be able to build it yourself.
This is a more advanced guide that shows how to build a native module. It assumes the reader knows Objective-C (Swift is not supported yet) and core libraries (Foundation, UIKit).
iOS Calendar module example #
This guide will use iOS Calendar API example. Let's say we would like to be able to access iOS calendar from JavaScript.
Native module is just an Objectve-C class that implements RCTBridgeModule protocol. If you are wondering, RCT is a shorthand for ReaCT.
// CalendarManager.h
#import "RCTBridgeModule.h"
@interface CalendarManager : NSObject <RCTBridgeModule>
@@ -59,7 +59,7 @@ CalendarManager.);
...
// Don't forget to unsubscribe
-subscription.remove();For more examples of sending events to JavaScript, see RCTLocationObserver.
NavigatorIOS
NavigatorIOS wraps UIKit navigation and allows you to add back-swipe
+
React Native | Build Native Apps Using React NavigatorIOS
NavigatorIOS wraps UIKit navigation and allows you to add back-swipe
functionality across your app.
Routes #
A route is an object used to describe each page in the navigator. The first
route is provided to NavigatorIOS as initialRoute:
render: function() {
return (
diff --git a/docs/netinfo.html b/docs/netinfo.html
index fb1944468d0..bd96ee32ee7 100644
--- a/docs/netinfo.html
+++ b/docs/netinfo.html
@@ -1,4 +1,4 @@
-React Native | Build Native Apps Using React NetInfo
NetInfo exposes info about online/offline status
== iOS Reachability
Asyncronously determine if the device is online and on a cellular network.
- "none" - device is offline
- "wifi" - device is online and connected via wifi, or is the iOS simulator
- "cell" - device is connected via Edge, 3G, WiMax, or LTE
- "unknown" - error case and the network status is unknown
NetInfo.reachabilityIOS.fetch().done((reach) => {
+React Native | Build Native Apps Using React NetInfo
NetInfo exposes info about online/offline status
reachabilityIOS #
Asyncronously determine if the device is online and on a cellular network.
none - device is offlinewifi - device is online and connected via wifi, or is the iOS simulatorcell - device is connected via Edge, 3G, WiMax, or LTEunknown - error case and the network status is unknown
NetInfo.reachabilityIOS.fetch().done((reach) => {
console.log('Initial: ' + reach);
});
function handleFirstReachabilityChange(reach) {
@@ -11,6 +11,20 @@
NetInfo.reachabilityIOS.addEventListener(
'change',
handleFirstReachabilityChange
+);isConnected #
Available on all platforms. Asyncronously fetch a boolean to determine
+internet connectivity.
NetInfo.isConnected.fetch().done((isConnected) => {
+ console.log('First, is ' + (isConnected ? 'online' : 'offline'));
+});
+function handleFirstConnectivityChange(isConnected) {
+ console.log('Then, is ' + (isConnected ? 'online' : 'offline'));
+ NetInfo.isConnected.removeEventListener(
+ 'change',
+ handleFirstConnectivityChange
+ );
+}
+NetInfo.isConnected.addEventListener(
+ 'change',
+ handleFirstConnectivityChange
);Network
One of React Native goal is to be a playground where we can experiment with different architectures and crazy ideas. Since browsers are not flexible enough, we had no choice but to reimplement the entire stack. In the places that we did not intend to change, we tried to be as faithful as possible to the browser APIs. The networking stack is a great example.
XMLHttpRequest #
XMLHttpRequest API is implemented on-top of iOS networking apis. The notable difference from web is the security model: you can read from arbitrary websites on the internet since there is no concept of CORS.
var request = new XMLHttpRequest();
+React Native | Build Native Apps Using React Network
One of React Native goal is to be a playground where we can experiment with different architectures and crazy ideas. Since browsers are not flexible enough, we had no choice but to reimplement the entire stack. In the places that we did not intend to change, we tried to be as faithful as possible to the browser APIs. The networking stack is a great example.
XMLHttpRequest #
XMLHttpRequest API is implemented on-top of iOS networking apis. The notable difference from web is the security model: you can read from arbitrary websites on the internet since there is no concept of CORS.
var request = new XMLHttpRequest();
request.onreadystatechange = (e) => {
if (request.readyState !== 4) {
return;
diff --git a/docs/panresponder.html b/docs/panresponder.html
index 257c3b425d9..71747d0cb9f 100644
--- a/docs/panresponder.html
+++ b/docs/panresponder.html
@@ -1,4 +1,4 @@
-React Native | Build Native Apps Using React PanResponder
+----------------------------+ +--------------------------------+
+
React Native | Build Native Apps Using React PanResponder
+----------------------------+ +--------------------------------+
| ResponderTouchHistoryStore | |TouchHistoryMath |
+----------------------------+ +----------+---------------------+
|Global store of touchHistory| |Allocation-less math util |
diff --git a/docs/pickerios.html b/docs/pickerios.html
index e6124ceeb9f..2bc33e7f0b2 100644
--- a/docs/pickerios.html
+++ b/docs/pickerios.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React PixelRatio
PixelRatio class gives access to the device pixel density.
There are a few use cases for using PixelRatio:
Displaying a line that's as thin as the device permits #
A width of 1 is actually pretty thick on an iPhone 4+, we can do one that's
+
React Native | Build Native Apps Using React PixelRatio
PixelRatio class gives access to the device pixel density.
There are a few use cases for using PixelRatio:
Displaying a line that's as thin as the device permits #
A width of 1 is actually pretty thick on an iPhone 4+, we can do one that's
thinner using a width of 1 / PixelRatio.get(). It's a technique that works
on all the devices independent of their pixel density.
style={{ borderWidth: 1 / PixelRatio.get() }}Fetching a correctly sized image #
You should get a higher resolution image if you are on a high pixel density
device. A good rule of thumb is to multiply the size of the image you display
diff --git a/docs/pushnotificationios.html b/docs/pushnotificationios.html
index 901ef3b871e..46879e33700 100644
--- a/docs/pushnotificationios.html
+++ b/docs/pushnotificationios.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React PushNotificationIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the
+
React Native | Build Native Apps Using React PushNotificationIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
static setApplicationIconBadgeNumber(number) #
static getApplicationIconBadgeNumber(callback) #
static addEventListener(type, handler) #
static requestPermissions() #
static checkPermissions(callback) #
static removeEventListener(type, handler) #
static popInitialNotification() #
0constructor(nativeNotif) #
0getMessage() #
0getSound() #
0getAlert() #
0getBadgeCount() #
0getData() #
ReactNavigator
Props #
configureScene function #
initialRoute object #
initialRouteStack [object] #
navigationBar node #
navigator object #
onDidFocus function #
onItemRef function #
onWillFocus function #
renderScene function #
sceneStyle #
shouldJumpOnBackstackPop bool #
Should the backstack back button "jump" back instead of pop? Set to true
+
React Native | Build Native Apps Using React ReactNavigator
Props #
configureScene function #
initialRoute object #
initialRouteStack [object] #
navigationBar node #
navigator object #
onDidFocus function #
onItemRef function #
onWillFocus function #
renderScene function #
sceneStyle #
shouldJumpOnBackstackPop bool #
Should the backstack back button "jump" back instead of pop? Set to true
if a jump forward might happen after the android back button is pressed,
so the scenes will remain mounted
ScrollView
Component that wraps platform ScrollView while providing
+
React Native | Build Native Apps Using React ScrollView
Component that wraps platform ScrollView while providing
integration with touch locking "responder" system.
Doesn't yet support other contained responders from blocking this scroll
view from becoming the responder.
Props #
alwaysBounceHorizontal bool #
When true, the scroll view bounces horizontally when it reaches the end
even if the content is smaller than the scroll view itself. The default
diff --git a/docs/sliderios.html b/docs/sliderios.html
index e649d3b3c98..74c3a6292d6 100644
--- a/docs/sliderios.html
+++ b/docs/sliderios.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React SliderIOS
Props #
onSlidingComplete function #
Callback called when the user finishes changing the value (e.g. when
+
React Native | Build Native Apps Using React SliderIOS
Props #
onSlidingComplete function #
Callback called when the user finishes changing the value (e.g. when
the slider is released).
onValueChange function #
Callback continuously called while the user is dragging the slider.
style View#style #
Used to style and layout the Slider. See StyleSheet.js and
ViewStylePropTypes.js for more info.
value number #
Initial value of the slider. The value should be between 0 and 1.
Default value is 0.
This is not a controlled component, e.g. if you don't update
diff --git a/docs/statusbarios.html b/docs/statusbarios.html
index 7b192a4edd9..c782f4949b1 100644
--- a/docs/statusbarios.html
+++ b/docs/statusbarios.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React StatusBarIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the
+
React Native | Build Native Apps Using React StatusBarIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
Style
React Native doesn't implement CSS but instead relies on JavaScript to let you style your application. This has been a controversial decision and you can read through those slides for the rationale behind it.
+React Native | Build Native Apps Using React Style
React Native doesn't implement CSS but instead relies on JavaScript to let you style your application. This has been a controversial decision and you can read through those slides for the rationale behind it.
Declare Styles #
The way to declare styles in React Native is the following:
var styles = StyleSheet.create({
base: {
diff --git a/docs/stylesheet.html b/docs/stylesheet.html
index 3eb66c9992b..52506d2296a 100644
--- a/docs/stylesheet.html
+++ b/docs/stylesheet.html
@@ -1,4 +1,4 @@
-React Native | Build Native Apps Using React StyleSheet
A StyleSheet is an abstraction similar to CSS StyleSheets
Create a new StyleSheet:
var styles = StyleSheet.create({
+React Native | Build Native Apps Using React StyleSheet
A StyleSheet is an abstraction similar to CSS StyleSheets
Create a new StyleSheet:
var styles = StyleSheet.create({
container: {
borderRadius: 4,
borderWidth: 0.5,
diff --git a/docs/switchios.html b/docs/switchios.html
index 2974073572c..98f64dd81f5 100644
--- a/docs/switchios.html
+++ b/docs/switchios.html
@@ -1,4 +1,4 @@
-React Native | Build Native Apps Using React SwitchIOS
Use SwitchIOS to render a boolean input on iOS. This is
+
React Native | Build Native Apps Using React SwitchIOS
Use SwitchIOS to render a boolean input on iOS. This is
a controlled component, so you must hook in to the onValueChange callback
and update the value prop in order for the component to update, otherwise
the user's change will be reverted immediately to reflect props.value as the
diff --git a/docs/tabbarios.html b/docs/tabbarios.html
index b3e968cae13..e6784cfdc64 100644
--- a/docs/tabbarios.html
+++ b/docs/tabbarios.html
@@ -1,4 +1,4 @@
-
React Native | Build Native Apps Using React
Animation
All rights reserved.
This source code is licensed under the BSD-style license found in the +
Animation
All rights reserved.
This source code is licensed under the BSD-style license found in the LICENSE file in the root directory of this source tree. An additional grant of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
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
diff --git a/docs/appstateios.html b/docs/appstateios.html
index a0826c8d742..01bfde6d185 100644
--- a/docs/appstateios.html
+++ b/docs/appstateios.html
@@ -1,6 +1,32 @@
-
AppStateIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the -LICENSE file in the root directory of this source tree. An additional grant -of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
AppStateIOS
AppStateIOS can tell you if the app is in the foreground or background,
+and notify you when the state changes.
AppStateIOS is frequently used to determine the intent and proper behavior when +handling push notifications.
iOS 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 transition state that currently never happens for + typical React Native apps.
For more information, see +Apple's documentation
Basic Usage #
To see the current state, you can check AppStateIOS.currentState, which
+will be kept up-to-date. However, currentState will be null at launch
+while AppStateIOS retrieves it over the bridge.
This example will only ever appear to say "Current state is: active" because
+the app is only visible to the user when in the active state, and the null
+state will happen only momentarily.
Methods #
AsyncStorage
AsyncStorage is a simple, asynchronous, persistent, global, key-value storage +
AsyncStorage
AsyncStorage is a simple, asynchronous, persistent, global, key-value storage system. It should be used instead of LocalStorage.
It is recommended that you use an abstraction on top of AsyncStorage instead of AsyncStorage directly for anything more than light usage since it operates globally.
This JS code is a simple facad over the native iOS implementation to provide diff --git a/docs/cameraroll.html b/docs/cameraroll.html index 6f9ee7715db..c737e2857b2 100644 --- a/docs/cameraroll.html +++ b/docs/cameraroll.html @@ -1,4 +1,4 @@ -
CameraRoll
All rights reserved.
This source code is licensed under the BSD-style license found in the +
CameraRoll
All rights reserved.
This source code is licensed under the BSD-style license found in the LICENSE file in the root directory of this source tree. An additional grant of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
static saveImageWithTag(tag: string, successCallback, errorCallback) #
Saves the image with tag tag to the camera roll.
@param {string} tag - Can be any of the three kinds of tags we accept: 1. URL diff --git a/docs/datepickerios.html b/docs/datepickerios.html index 983d1485378..ac8f556f0a4 100644 --- a/docs/datepickerios.html +++ b/docs/datepickerios.html @@ -1,4 +1,4 @@ -
DatePickerIOS
Use DatePickerIOS to render a date/time picker (selector) on iOS. This is
+
DatePickerIOS
Use 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
diff --git a/docs/flexbox.html b/docs/flexbox.html
index 1bdb991eb58..7bcffcdd288 100644
--- a/docs/flexbox.html
+++ b/docs/flexbox.html
@@ -1,4 +1,4 @@
-
Flexbox
Props #
alignItems enum('flex-start', 'flex-end', 'center', 'stretch') #
alignSelf enum('auto', 'flex-start', 'flex-end', 'center', 'stretch') #
borderBottomWidth number #
borderLeftWidth number #
borderRightWidth number #
borderTopWidth number #
borderWidth number #
bottom number #
flex number #
flexDirection enum('row', 'column') #
flexWrap enum('wrap', 'nowrap') #
height number #
justifyContent enum('flex-start', 'flex-end', 'center', 'space-between', 'space-around') #
left number #
margin number #
marginBottom number #
marginHorizontal number #
marginLeft number #
marginRight number #
marginTop number #
marginVertical number #
padding number #
paddingBottom number #
paddingHorizontal number #
paddingLeft number #
paddingRight number #
paddingTop number #
paddingVertical number #
position enum('absolute', 'relative') #
right number #
top number #
width number #
Flexbox
Props #
alignItems enum('flex-start', 'flex-end', 'center', 'stretch') #
alignSelf enum('auto', 'flex-start', 'flex-end', 'center', 'stretch') #
borderBottomWidth number #
borderLeftWidth number #
borderRightWidth number #
borderTopWidth number #
borderWidth number #
bottom number #
flex number #
flexDirection enum('row', 'column') #
flexWrap enum('wrap', 'nowrap') #
height number #
justifyContent enum('flex-start', 'flex-end', 'center', 'space-between', 'space-around') #
left number #
margin number #
marginBottom number #
marginHorizontal number #
marginLeft number #
marginRight number #
marginTop number #
marginVertical number #
padding number #
paddingBottom number #
paddingHorizontal number #
paddingLeft number #
paddingRight number #
paddingTop number #
paddingVertical number #
position enum('absolute', 'relative') #
right number #
top number #
width number #
Geolocation
/!\ ATTENTION /!\ +
Geolocation
/!\ ATTENTION /!\ You need to add NSLocationWhenInUseUsageDescription key in Info.plist to enable geolocation, otherwise it's going to fail silently! diff --git a/docs/gesture-responder-system.html b/docs/gesture-responder-system.html index cca37ea56a3..010ed653aa4 100644 --- a/docs/gesture-responder-system.html +++ b/docs/gesture-responder-system.html @@ -1,4 +1,4 @@ -
Gesture Responder System
Gesture recognition on mobile devices is much more complicated than web. A touch can go through several phases as the app determines what the user's intention is. For example, the app needs to determine if the touch is scrolling, sliding on a widget, or tapping. This can even change during the duration of a touch. There can also be multiple simultaneous touches.
The touch responder system is needed to allow components to negotiate these touch interactions without any additional knowledge about their parent or child components. This system is implemented in ResponderEventPlugin.js, which contains further details and documentation.
Best Practices #
Users can feel huge differences in the usability of web apps vs. native, and this is one of the big causes. Every action should have the following attributes:
- Feedback/highlighting- show the user what is handling their touch, and what will happen when they release the gesture
- Cancel-ability- when making an action, the user should be able to abort it mid-touch by dragging their finger away
These features make users more comfortable while using an app, because it allows people to experiment and interact without fear of making mistakes.
TouchableHighlight and Touchable* #
The responder system can be complicated to use. So we have provided an abstract Touchable implementation for things that should be "tappable". This uses the responder system and allows you to easily configure tap interactions declaratively. Use TouchableHighlight anywhere where you would use a button or link on web.
Responder Lifecycle #
A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder:
View.props.onStartShouldSetResponder: (evt) => true,- Does this view want to become responder on the start of a touch?View.props.onMoveShouldSetResponder: (evt) => true,- Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
If the View returns true and attempts to become the responder, one of the following will happen:
View.props.onResponderGrant: (evt) => {}- The View is now responding for touch events. This is the time to highlight and show the user what is happeningView.props.onResponderReject: (evt) => {}- Something else is the responder right now and will not release it
If the view is responding, the following handlers can be called:
View.props.onResponderMove: (moveEvt) => {}- The user is moving their fingerView.props.onResponderRelease: (releaseEvt) => {}- Fired at the end of the touch, ie "touchUp"View.props.onResponderTerminationRequest: (evt) => true- Something else wants to become responder. Should this view release the responder? Returning true allows releaseView.props.onResponderTerminate: (evt) => {}- The responder has been taken from the View. Might be taken by other views after a call toonResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)
Capture ShouldSet Handlers #
onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
View.props.onStartShouldSetResponderCapture: (evt) => true,View.props.onMoveShouldSetResponderCapture: (evt) => true,
PanResponder #
For higher-level gesture interpretation, check out PanResponder.
Gesture Responder System
Gesture recognition on mobile devices is much more complicated than web. A touch can go through several phases as the app determines what the user's intention is. For example, the app needs to determine if the touch is scrolling, sliding on a widget, or tapping. This can even change during the duration of a touch. There can also be multiple simultaneous touches.
The touch responder system is needed to allow components to negotiate these touch interactions without any additional knowledge about their parent or child components. This system is implemented in ResponderEventPlugin.js, which contains further details and documentation.
Best Practices #
Users can feel huge differences in the usability of web apps vs. native, and this is one of the big causes. Every action should have the following attributes:
- Feedback/highlighting- show the user what is handling their touch, and what will happen when they release the gesture
- Cancel-ability- when making an action, the user should be able to abort it mid-touch by dragging their finger away
These features make users more comfortable while using an app, because it allows people to experiment and interact without fear of making mistakes.
TouchableHighlight and Touchable* #
The responder system can be complicated to use. So we have provided an abstract Touchable implementation for things that should be "tappable". This uses the responder system and allows you to easily configure tap interactions declaratively. Use TouchableHighlight anywhere where you would use a button or link on web.
Responder Lifecycle #
A view can become the touch responder by implementing the correct negotiation methods. There are two methods to ask the view if it wants to become responder:
View.props.onStartShouldSetResponder: (evt) => true,- Does this view want to become responder on the start of a touch?View.props.onMoveShouldSetResponder: (evt) => true,- Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
If the View returns true and attempts to become the responder, one of the following will happen:
View.props.onResponderGrant: (evt) => {}- The View is now responding for touch events. This is the time to highlight and show the user what is happeningView.props.onResponderReject: (evt) => {}- Something else is the responder right now and will not release it
If the view is responding, the following handlers can be called:
View.props.onResponderMove: (moveEvt) => {}- The user is moving their fingerView.props.onResponderRelease: (releaseEvt) => {}- Fired at the end of the touch, ie "touchUp"View.props.onResponderTerminationRequest: (evt) => true- Something else wants to become responder. Should this view release the responder? Returning true allows releaseView.props.onResponderTerminate: (evt) => {}- The responder has been taken from the View. Might be taken by other views after a call toonResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)
Capture ShouldSet Handlers #
onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
View.props.onStartShouldSetResponderCapture: (evt) => true,View.props.onMoveShouldSetResponderCapture: (evt) => true,
PanResponder #
For higher-level gesture interpretation, check out PanResponder.
Getting Started
Requirements #
- OS X - This repo only contains the iOS implementation right now, and Xcode only runs on Mac.
- New to Xcode? Download it from the Mac App Store.
- Homebrew is the recommended way to install node, watchman, and flow.
brew install node. New to node or npm?brew install watchman. We recommend installing watchman, otherwise you might hit a node file watching bug.brew install flow. If you want to use flow.
Quick start #
npm install -g react-native-clireact-native init AwesomeProject
In the newly created folder AwesomeProject/
- Open
AwesomeProject.xcodeprojand hit run in Xcode - Open
index.ios.jsin your text editor of choice and edit some lines - Hit cmd+R (twice) in your iOS simulator to reload the app and see your change!
Congratulations! You've just successfully run and modified your first React Native app.
Getting Started
Requirements #
- OS X - This repo only contains the iOS implementation right now, and Xcode only runs on Mac.
- New to Xcode? Download it from the Mac App Store.
- Homebrew is the recommended way to install node, watchman, and flow.
brew install node. New to node or npm?brew install watchman. We recommend installing watchman, otherwise you might hit a node file watching bug.brew install flow. If you want to use flow.
Quick start #
npm install -g react-native-clireact-native init AwesomeProject
In the newly created folder AwesomeProject/
- Open
AwesomeProject.xcodeprojand hit run in Xcode - Open
index.ios.jsin your text editor of choice and edit some lines - Hit cmd+R (twice) in your iOS simulator to reload the app and see your change!
Congratulations! You've just successfully run and modified your first React Native app.
Image
A react component for displaying different types of images, +
Image
A react component for displaying different types of images, including network images, static resources, temporary local images, and images from local disk, such as the camera roll.
Example usage:
InteractionManager
InteractionManager allows long-running work to be scheduled after any +
InteractionManager
InteractionManager allows long-running work to be scheduled after any interactions/animations have completed. In particular, this allows JavaScript animations to run smoothly.
Applications can schedule tasks to run after interactions with the following:
LayoutAnimation
All rights reserved.
This source code is licensed under the BSD-style license found in the +
LayoutAnimation
All rights reserved.
This source code is licensed under the BSD-style license found in the LICENSE file in the root directory of this source tree. An additional grant of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
ListView
ListView - A core component designed for efficient display of vertically +
ListView
ListView - A core component designed for efficient display of vertically
scrolling lists of changing data. The minimal API is to create a
ListView.DataSource, populate it with a simple array of data blobs, and
instantiate a ListView component with that data source and a renderRow
diff --git a/docs/mapview.html b/docs/mapview.html
index a42ec5abea3..5f4585d045f 100644
--- a/docs/mapview.html
+++ b/docs/mapview.html
@@ -1,4 +1,4 @@
-
MapView
Props #
legalLabelInsets {top: number, left: number, bottom: number, right: number} #
Insets for the map's legal label, originally at bottom left of the map. +
MapView
Props #
legalLabelInsets {top: number, left: number, bottom: number, right: number} #
Insets for the map's legal label, originally at bottom left of the map.
See EdgeInsetsPropType.js for more information.
maxDelta number #
Maximum size of area that can be displayed.
minDelta number #
Minimum size of area that can be displayed.
onRegionChange function #
Callback that is called continuously when the user is dragging the map.
onRegionChangeComplete function #
Callback that is called once, when the user is done moving the map.
pitchEnabled bool #
When this property is set to true and a valid camera is associated
with the map, the camera’s pitch angle is used to tilt the plane
of the map. When this property is set to false, the camera’s pitch
diff --git a/docs/nativemodulesios.html b/docs/nativemodulesios.html
index 926de3bd9ce..6eee1bc2115 100644
--- a/docs/nativemodulesios.html
+++ b/docs/nativemodulesios.html
@@ -1,4 +1,4 @@
-
Native Modules (iOS)
Sometimes an app needs access to platform API, and React Native doesn't have a corresponding wrapper yet. Maybe you want to reuse some existing Objective-C or C++ code without having to reimplement it in JavaScript. Or write some high performance, multi-threaded code such as image processing, network stack, database or rendering.
We designed React Native such that it is possible for you to write real native code and have access to the full power of the platform. This is a more advanced feature and we don't expect it to be part of the usual development process, however it is essential that it exists. If React Native doesn't support a native feature that you need, you should be able to build it yourself.
This is a more advanced guide that shows how to build a native module. It assumes the reader knows Objective-C (Swift is not supported yet) and core libraries (Foundation, UIKit).
iOS Calendar module example #
This guide will use iOS Calendar API example. Let's say we would like to be able to access iOS calendar from JavaScript.
Native module is just an Objectve-C class that implements RCTBridgeModule protocol. If you are wondering, RCT is a shorthand for ReaCT.
Native Modules (iOS)
Sometimes an app needs access to platform API, and React Native doesn't have a corresponding wrapper yet. Maybe you want to reuse some existing Objective-C or C++ code without having to reimplement it in JavaScript. Or write some high performance, multi-threaded code such as image processing, network stack, database or rendering.
We designed React Native such that it is possible for you to write real native code and have access to the full power of the platform. This is a more advanced feature and we don't expect it to be part of the usual development process, however it is essential that it exists. If React Native doesn't support a native feature that you need, you should be able to build it yourself.
This is a more advanced guide that shows how to build a native module. It assumes the reader knows Objective-C (Swift is not supported yet) and core libraries (Foundation, UIKit).
iOS Calendar module example #
This guide will use iOS Calendar API example. Let's say we would like to be able to access iOS calendar from JavaScript.
Native module is just an Objectve-C class that implements RCTBridgeModule protocol. If you are wondering, RCT is a shorthand for ReaCT.
For more examples of sending events to JavaScript, see RCTLocationObserver.
NavigatorIOS
NavigatorIOS wraps UIKit navigation and allows you to add back-swipe +
NavigatorIOS
NavigatorIOS wraps UIKit navigation and allows you to add back-swipe functionality across your app.
Routes #
A route is an object used to describe each page in the navigator. The first
route is provided to NavigatorIOS as initialRoute:
NetInfo
NetInfo exposes info about online/offline status
== iOS Reachability
Asyncronously determine if the device is online and on a cellular network.
- "none" - device is offline
- "wifi" - device is online and connected via wifi, or is the iOS simulator
- "cell" - device is connected via Edge, 3G, WiMax, or LTE
- "unknown" - error case and the network status is unknown
NetInfo
NetInfo exposes info about online/offline status
reachabilityIOS #
Asyncronously determine if the device is online and on a cellular network.
none- device is offlinewifi- device is online and connected via wifi, or is the iOS simulatorcell- device is connected via Edge, 3G, WiMax, or LTEunknown- error case and the network status is unknown
isConnected #
Available on all platforms. Asyncronously fetch a boolean to determine +internet connectivity.
Network
One of React Native goal is to be a playground where we can experiment with different architectures and crazy ideas. Since browsers are not flexible enough, we had no choice but to reimplement the entire stack. In the places that we did not intend to change, we tried to be as faithful as possible to the browser APIs. The networking stack is a great example.
XMLHttpRequest #
XMLHttpRequest API is implemented on-top of iOS networking apis. The notable difference from web is the security model: you can read from arbitrary websites on the internet since there is no concept of CORS.
Network
One of React Native goal is to be a playground where we can experiment with different architectures and crazy ideas. Since browsers are not flexible enough, we had no choice but to reimplement the entire stack. In the places that we did not intend to change, we tried to be as faithful as possible to the browser APIs. The networking stack is a great example.
XMLHttpRequest #
XMLHttpRequest API is implemented on-top of iOS networking apis. The notable difference from web is the security model: you can read from arbitrary websites on the internet since there is no concept of CORS.
PanResponder
+----------------------------+ +--------------------------------+ +
PanResponder
+----------------------------+ +--------------------------------+ | ResponderTouchHistoryStore | |TouchHistoryMath | +----------------------------+ +----------+---------------------+ |Global store of touchHistory| |Allocation-less math util | diff --git a/docs/pickerios.html b/docs/pickerios.html index e6124ceeb9f..2bc33e7f0b2 100644 --- a/docs/pickerios.html +++ b/docs/pickerios.html @@ -1,4 +1,4 @@ -
PixelRatio
PixelRatio class gives access to the device pixel density.
There are a few use cases for using PixelRatio:
Displaying a line that's as thin as the device permits #
A width of 1 is actually pretty thick on an iPhone 4+, we can do one that's +
PixelRatio
PixelRatio class gives access to the device pixel density.
There are a few use cases for using PixelRatio:
Displaying a line that's as thin as the device permits #
A width of 1 is actually pretty thick on an iPhone 4+, we can do one that's
thinner using a width of 1 / PixelRatio.get(). It's a technique that works
on all the devices independent of their pixel density.
Fetching a correctly sized image #
You should get a higher resolution image if you are on a high pixel density device. A good rule of thumb is to multiply the size of the image you display diff --git a/docs/pushnotificationios.html b/docs/pushnotificationios.html index 901ef3b871e..46879e33700 100644 --- a/docs/pushnotificationios.html +++ b/docs/pushnotificationios.html @@ -1,4 +1,4 @@ -
PushNotificationIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the +
PushNotificationIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the LICENSE file in the root directory of this source tree. An additional grant of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
static setApplicationIconBadgeNumber(number) #
static getApplicationIconBadgeNumber(callback) #
static addEventListener(type, handler) #
static requestPermissions() #
static checkPermissions(callback) #
static removeEventListener(type, handler) #
static popInitialNotification() #
0constructor(nativeNotif) #
0getMessage() #
0getSound() #
0getAlert() #
0getBadgeCount() #
0getData() #
ReactNavigator
Props #
configureScene function #
initialRoute object #
initialRouteStack [object] #
navigationBar node #
navigator object #
onDidFocus function #
onItemRef function #
onWillFocus function #
renderScene function #
sceneStyle #
shouldJumpOnBackstackPop bool #
Should the backstack back button "jump" back instead of pop? Set to true +
ReactNavigator
Props #
configureScene function #
initialRoute object #
initialRouteStack [object] #
navigationBar node #
navigator object #
onDidFocus function #
onItemRef function #
onWillFocus function #
renderScene function #
sceneStyle #
shouldJumpOnBackstackPop bool #
Should the backstack back button "jump" back instead of pop? Set to true if a jump forward might happen after the android back button is pressed, so the scenes will remain mounted
ScrollView
Component that wraps platform ScrollView while providing +
ScrollView
Component that wraps platform ScrollView while providing integration with touch locking "responder" system.
Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.
Props #
alwaysBounceHorizontal bool #
When true, the scroll view bounces horizontally when it reaches the end even if the content is smaller than the scroll view itself. The default diff --git a/docs/sliderios.html b/docs/sliderios.html index e649d3b3c98..74c3a6292d6 100644 --- a/docs/sliderios.html +++ b/docs/sliderios.html @@ -1,4 +1,4 @@ -
SliderIOS
Props #
onSlidingComplete function #
Callback called when the user finishes changing the value (e.g. when +
SliderIOS
Props #
onSlidingComplete function #
Callback called when the user finishes changing the value (e.g. when the slider is released).
onValueChange function #
Callback continuously called while the user is dragging the slider.
style View#style #
Used to style and layout the Slider. See StyleSheet.js and
ViewStylePropTypes.js for more info.
value number #
Initial value of the slider. The value should be between 0 and 1. Default value is 0.
This is not a controlled component, e.g. if you don't update diff --git a/docs/statusbarios.html b/docs/statusbarios.html index 7b192a4edd9..c782f4949b1 100644 --- a/docs/statusbarios.html +++ b/docs/statusbarios.html @@ -1,4 +1,4 @@ -
StatusBarIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the +
StatusBarIOS
All rights reserved.
This source code is licensed under the BSD-style license found in the LICENSE file in the root directory of this source tree. An additional grant of patent rights can be found in the PATENTS file in the same directory.
@flow
Methods #
Style
React Native doesn't implement CSS but instead relies on JavaScript to let you style your application. This has been a controversial decision and you can read through those slides for the rationale behind it.
+Style
React Native doesn't implement CSS but instead relies on JavaScript to let you style your application. This has been a controversial decision and you can read through those slides for the rationale behind it.
Declare Styles #
The way to declare styles in React Native is the following:
StyleSheet
A StyleSheet is an abstraction similar to CSS StyleSheets
Create a new StyleSheet:
StyleSheet
A StyleSheet is an abstraction similar to CSS StyleSheets
Create a new StyleSheet:
SwitchIOS
Use SwitchIOS to render a boolean input on iOS. This is
+
SwitchIOS
Use SwitchIOS to render a boolean input on iOS. This is
a controlled component, so you must hook in to the onValueChange callback
and update the value prop in order for the component to update, otherwise
the user's change will be reverted immediately to reflect props.value as the
diff --git a/docs/tabbarios.html b/docs/tabbarios.html
index b3e968cae13..e6784cfdc64 100644
--- a/docs/tabbarios.html
+++ b/docs/tabbarios.html
@@ -1,4 +1,4 @@
-