Animated
The Animated library is designed to make animations fluid, powerful, and easy to build and maintain. Animated focuses on declarative relationships between inputs and outputs, with configurable transforms in between, and simple start/stop methods to control time-based animation execution.
Animated
The Animated library is designed to make animations fluid, powerful, and painless to build and maintain. Animated focuses on declarative relationships between inputs and outputs, with configurable transforms in between, and start/stop methods to control time-based animation execution.
The simplest workflow for creating an animation is to to create an Animated.Value, hook it up to one or more style attributes of an animated component, and then drive updates via animations using Animated.timing():
Animated.timing(
// Animate value over time
@@ -90,7 +90,7 @@
Animated provides three types of animation types. Each animation type provides a particular animation curve that controls how your values animate from their initial value to the final value:
Animated.decay() starts with an initial velocity and gradually slows to a stop.Animated.spring() provides a simple spring physics model.Animated.spring() provides a basic spring physics model.Animated.timing() animates a value over time using easing functions.
In most cases, you will be using timing(). By default, it uses a symmetric easeInOut curve that conveys the gradual acceleration of an object to full speed and concludes by gradually decelerating to a stop.
@@ -100,7 +100,7 @@
By using the native driver, we send everything about the animation to native before starting the animation, allowing native code to perform the animation on the UI thread without having to go through the bridge on every frame. Once the animation has started, the JS thread can be blocked without affecting the animation.
You can use the native driver by specifying useNativeDriver: true in your animation configuration. See the Animations guide to learn more.
Animatable components
-Only animatable components can be animated. These special components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.
+Only animatable components can be animated. These unique components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.
createAnimatedComponent() can be used to make a component animatable.
@@ -119,7 +119,7 @@
Animated.sequence() starts the animations in order, waiting for each to complete before starting the next.Animated.stagger() starts animations in order and in parallel, but with successive delays.Animations can also be chained together simply by setting the toValue of one animation to be another Animated.Value. See Tracking dynamic values in the Animations guide.
+Animations can also be chained together by setting the toValue of one animation to be another Animated.Value. See Tracking dynamic values in the Animations guide.
By default, if one animation is stopped or interrupted, then all other animations in the group are also stopped.
Combining animated values
You can combine two animated values via addition, multiplication, division, or modulo to make a new animated value:
diff --git a/docs/0.48/animated/index.html b/docs/0.48/animated/index.html
index 0e722e49110..24b7a772228 100644
--- a/docs/0.48/animated/index.html
+++ b/docs/0.48/animated/index.html
@@ -1,4 +1,4 @@
-Animated · React Native Animated
The Animated library is designed to make animations fluid, powerful, and easy to build and maintain. Animated focuses on declarative relationships between inputs and outputs, with configurable transforms in between, and simple start/stop methods to control time-based animation execution.
Animated
The Animated library is designed to make animations fluid, powerful, and painless to build and maintain. Animated focuses on declarative relationships between inputs and outputs, with configurable transforms in between, and start/stop methods to control time-based animation execution.
The simplest workflow for creating an animation is to to create an Animated.Value, hook it up to one or more style attributes of an animated component, and then drive updates via animations using Animated.timing():
Animated.timing(
// Animate value over time
@@ -90,7 +90,7 @@
Animated provides three types of animation types. Each animation type provides a particular animation curve that controls how your values animate from their initial value to the final value:
Animated.decay() starts with an initial velocity and gradually slows to a stop.Animated.spring() provides a simple spring physics model.Animated.spring() provides a basic spring physics model.Animated.timing() animates a value over time using easing functions.
In most cases, you will be using timing(). By default, it uses a symmetric easeInOut curve that conveys the gradual acceleration of an object to full speed and concludes by gradually decelerating to a stop.
@@ -100,7 +100,7 @@
By using the native driver, we send everything about the animation to native before starting the animation, allowing native code to perform the animation on the UI thread without having to go through the bridge on every frame. Once the animation has started, the JS thread can be blocked without affecting the animation.
You can use the native driver by specifying useNativeDriver: true in your animation configuration. See the Animations guide to learn more.
Animatable components
-Only animatable components can be animated. These special components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.
+Only animatable components can be animated. These unique components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.
createAnimatedComponent() can be used to make a component animatable.
@@ -119,7 +119,7 @@
Animated.sequence() starts the animations in order, waiting for each to complete before starting the next.Animated.stagger() starts animations in order and in parallel, but with successive delays.Animations can also be chained together simply by setting the toValue of one animation to be another Animated.Value. See Tracking dynamic values in the Animations guide.
+Animations can also be chained together by setting the toValue of one animation to be another Animated.Value. See Tracking dynamic values in the Animations guide.
By default, if one animation is stopped or interrupted, then all other animations in the group are also stopped.
Combining animated values
You can combine two animated values via addition, multiplication, division, or modulo to make a new animated value:
diff --git a/docs/0.48/flatlist.html b/docs/0.48/flatlist.html
index f914e17768f..656560ff317 100644
--- a/docs/0.48/flatlist.html
+++ b/docs/0.48/flatlist.html
@@ -1,4 +1,4 @@
-FlatList · React Native FlatList
A performant interface for rendering simple, flat lists, supporting the most handy features:
+FlatList
A performant interface for rendering basic, flat lists, supporting the most handy features:
- Fully cross-platform.
- Optional horizontal mode. @@ -203,7 +203,7 @@ class MyList extends React.PureComponent {
data
-For simplicity, data is just a plain array. If you want to use something else, like an immutable list, use the underlying VirtualizedList directly.
For simplicity, data is a plain array. If you want to use something else, like an immutable list, use the underlying VirtualizedList directly.
| Type | Required |
|---|
getItemLayout
-getItemLayout is an optional optimizations that let us skip measurement of dynamic content if you know the height of items a priori. getItemLayout is the most efficient, and is easy to use if you have fixed height items, for example:
getItemLayout is an optional optimizations that let us skip measurement of dynamic content if you know the height of items a priori. getItemLayout is efficient if you have fixed height items, for example:
getItemLayout={(data, index) => (
{length: ITEM_HEIGHT, offset: ITEM_HEIGHT * index, index}
)}
diff --git a/docs/0.48/flatlist/index.html b/docs/0.48/flatlist/index.html
index f914e17768f..656560ff317 100644
--- a/docs/0.48/flatlist/index.html
+++ b/docs/0.48/flatlist/index.html
@@ -1,4 +1,4 @@
-FlatList · React Native FlatList
A performant interface for rendering simple, flat lists, supporting the most handy features:
+FlatList
A performant interface for rendering basic, flat lists, supporting the most handy features:
- Fully cross-platform.
- Optional horizontal mode. @@ -203,7 +203,7 @@ class MyList extends React.PureComponent {
data
-For simplicity, data is just a plain array. If you want to use something else, like an immutable list, use the underlying VirtualizedList directly.
For simplicity, data is a plain array. If you want to use something else, like an immutable list, use the underlying VirtualizedList directly.
| Type | Required |
|---|
getItemLayout
-getItemLayout is an optional optimizations that let us skip measurement of dynamic content if you know the height of items a priori. getItemLayout is the most efficient, and is easy to use if you have fixed height items, for example:
getItemLayout is an optional optimizations that let us skip measurement of dynamic content if you know the height of items a priori. getItemLayout is efficient if you have fixed height items, for example:
getItemLayout={(data, index) => (
{length: ITEM_HEIGHT, offset: ITEM_HEIGHT * index, index}
)}
diff --git a/docs/0.48/layout-props.html b/docs/0.48/layout-props.html
index d58fab3dd19..479af5817d0 100644
--- a/docs/0.48/layout-props.html
+++ b/docs/0.48/layout-props.html
@@ -571,9 +571,9 @@
position
-position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always just relative to the parent.
+position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always relative to the parent.
If you want to position a child using specific numbers of logical pixels relative to its parent, set the child to have absolute position.
-If you want to position a child relative to something that is not its parent, just don't use styles for that. Use the component tree.
+If you want to position a child relative to something that is not its parent, don't use styles for that. Use the component tree.
See https://github.com/facebook/yoga for more details on how position differs between React Native and CSS.
diff --git a/docs/0.48/layout-props/index.html b/docs/0.48/layout-props/index.html
index d58fab3dd19..479af5817d0 100644
--- a/docs/0.48/layout-props/index.html
+++ b/docs/0.48/layout-props/index.html
@@ -571,9 +571,9 @@
position
-position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always just relative to the parent.
+position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always relative to the parent.
If you want to position a child using specific numbers of logical pixels relative to its parent, set the child to have absolute position.
-If you want to position a child relative to something that is not its parent, just don't use styles for that. Use the component tree.
+If you want to position a child relative to something that is not its parent, don't use styles for that. Use the component tree.
See https://github.com/facebook/yoga for more details on how position differs between React Native and CSS.
diff --git a/docs/0.48/listview.html b/docs/0.48/listview.html
index 4fca7394bd8..88191e7630f 100644
--- a/docs/0.48/listview.html
+++ b/docs/0.48/listview.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.48/listview/index.html b/docs/0.48/listview/index.html
index 4fca7394bd8..88191e7630f 100644
--- a/docs/0.48/listview/index.html
+++ b/docs/0.48/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.48/listviewdatasource.html b/docs/0.48/listviewdatasource.html
index 2ca7e0f57ea..c49244d0aaf 100644
--- a/docs/0.48/listviewdatasource.html
+++ b/docs/0.48/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.48/listviewdatasource/index.html b/docs/0.48/listviewdatasource/index.html
index 2ca7e0f57ea..c49244d0aaf 100644
--- a/docs/0.48/listviewdatasource/index.html
+++ b/docs/0.48/listviewdatasource/index.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.48/modal.html b/docs/0.48/modal.html
index 17c4b8967d8..6577e2eabc1 100644
--- a/docs/0.48/modal.html
+++ b/docs/0.48/modal.html
@@ -1,4 +1,4 @@
-Modal · React Native
EditModal
The Modal component is a simple way to present content above an enclosing view.
+ EditModal
The Modal component is a basic way to present content above an enclosing view.
Note: If you need more control over how to present modals over the rest of your app, then consider using a top-level Navigator.
import React, {Component} from 'react';
import {Modal, Text, TouchableHighlight, View} from 'react-native';
diff --git a/docs/0.48/modal/index.html b/docs/0.48/modal/index.html
index 17c4b8967d8..6577e2eabc1 100644
--- a/docs/0.48/modal/index.html
+++ b/docs/0.48/modal/index.html
@@ -1,4 +1,4 @@
-Modal · React Native
EditModal
The Modal component is a simple way to present content above an enclosing view.
+ EditModal
The Modal component is a basic way to present content above an enclosing view.
Note: If you need more control over how to present modals over the rest of your app, then consider using a top-level Navigator.
import React, {Component} from 'react';
import {Modal, Text, TouchableHighlight, View} from 'react-native';
diff --git a/docs/0.48/navigatorios.html b/docs/0.48/navigatorios.html
index 6a788316cb0..18afbeb4d7b 100644
--- a/docs/0.48/navigatorios.html
+++ b/docs/0.48/navigatorios.html
@@ -248,7 +248,7 @@ render() {
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -356,7 +356,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -437,7 +437,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.48/navigatorios/index.html b/docs/0.48/navigatorios/index.html
index 6a788316cb0..18afbeb4d7b 100644
--- a/docs/0.48/navigatorios/index.html
+++ b/docs/0.48/navigatorios/index.html
@@ -248,7 +248,7 @@ render() {
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -356,7 +356,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -437,7 +437,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.48/scrollview.html b/docs/0.48/scrollview.html
index 639cb9803d5..80a551f2421 100644
--- a/docs/0.48/scrollview.html
+++ b/docs/0.48/scrollview.html
@@ -69,12 +69,12 @@
}
});
EditScrollView
Component that wraps platform ScrollView while providing integration with touch locking "responder" system.
-Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes easy to debug.
+Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes quick to debug.
Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.
<ScrollView> vs <FlatList> - which one to use?
-ScrollView simply renders all its react child components at once. That makes it very easy to understand and use.
-On the other hand, this has a performance downside. Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.
-This is where FlatList comes into play. FlatList renders items lazily, just when they are about to appear, and removes items that scroll way off screen to save memory and processing time.
+ScrollView renders all its react child components at once, but this has a performance downside.
+Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.
+This is where FlatList comes into play. FlatList renders items lazily, when they are about to appear, and removes items that scroll way off screen to save memory and processing time.
FlatList is also handy if you want to render separators between your items, multiple columns, infinite scroll loading, or any number of other features it supports out of the box.
Props
@@ -556,8 +556,8 @@ const styles = StyleSheet.create({
The style of the scroll indicators.
'default' (the default), same as black.'black', scroll indicator is black. This style is good against a light background.'white', scroll indicator is white. This style is good against a dark background.'black', scroll indicator is black. This style is good against a light background.'white', scroll indicator is white. This style is good against a dark background.
diff --git a/docs/0.48/scrollview/index.html b/docs/0.48/scrollview/index.html
index 639cb9803d5..80a551f2421 100644
--- a/docs/0.48/scrollview/index.html
+++ b/docs/0.48/scrollview/index.html
@@ -69,12 +69,12 @@
}
});
EditScrollView
Component that wraps platform ScrollView while providing integration with touch locking "responder" system.
-Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes easy to debug.
+Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes quick to debug.
Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.
<ScrollView> vs <FlatList> - which one to use?
-ScrollView simply renders all its react child components at once. That makes it very easy to understand and use.
-On the other hand, this has a performance downside. Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.
-This is where FlatList comes into play. FlatList renders items lazily, just when they are about to appear, and removes items that scroll way off screen to save memory and processing time.
+ScrollView renders all its react child components at once, but this has a performance downside.
+Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.
+This is where FlatList comes into play. FlatList renders items lazily, when they are about to appear, and removes items that scroll way off screen to save memory and processing time.
FlatList is also handy if you want to render separators between your items, multiple columns, infinite scroll loading, or any number of other features it supports out of the box.
Props
@@ -556,8 +556,8 @@ const styles = StyleSheet.create({
The style of the scroll indicators.
'default' (the default), same as black.'black', scroll indicator is black. This style is good against a light background.'white', scroll indicator is white. This style is good against a dark background.'black', scroll indicator is black. This style is good against a light background.'white', scroll indicator is white. This style is good against a dark background.
diff --git a/docs/0.48/sectionlist.html b/docs/0.48/sectionlist.html
index bb98c7d60a2..6e5257afcbc 100644
--- a/docs/0.48/sectionlist.html
+++ b/docs/0.48/sectionlist.html
@@ -82,7 +82,7 @@
- Scroll loading.
If you don't need section support and want a simpler interface, use <FlatList>.
-Simple Examples:
+Examples:
<SectionList
renderItem={({item}) => <ListItem title={item} />}
renderSectionHeader={({section}) => <Header title={section.title} />}
diff --git a/docs/0.48/sectionlist/index.html b/docs/0.48/sectionlist/index.html
index bb98c7d60a2..6e5257afcbc 100644
--- a/docs/0.48/sectionlist/index.html
+++ b/docs/0.48/sectionlist/index.html
@@ -82,7 +82,7 @@
- Scroll loading.
If you don't need section support and want a simpler interface, use <FlatList>.
-Simple Examples:
+Examples:
<SectionList
renderItem={({item}) => <ListItem title={item} />}
renderSectionHeader={({section}) => <Header title={section.title} />}
diff --git a/docs/0.48/view.html b/docs/0.48/view.html
index 9e416146c79..3d9d43abc1a 100644
--- a/docs/0.48/view.html
+++ b/docs/0.48/view.html
@@ -390,7 +390,7 @@
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform Animated · React Native EditAnimated
The Animated library is designed to make animations fluid, powerful, and easy to build and maintain. Animated focuses on declarative relationships between inputs and outputs, with configurable transforms in between, and simple start/stop methods to control time-based animation execution.
+ EditAnimated
The Animated library is designed to make animations fluid, powerful, and handy to build and maintain. Animated focuses on declarative relationships between inputs and outputs, with configurable transforms in between, and basic start/stop methods to control time-based animation execution.
The simplest workflow for creating an animation is to create an Animated.Value, hook it up to one or more style attributes of an animated component, and then drive updates via animations using Animated.timing():
Animated.timing(
// Animate value over time
@@ -90,7 +90,7 @@
Animated provides three types of animation types. Each animation type provides a particular animation curve that controls how your values animate from their initial value to the final value:
Animated.decay() starts with an initial velocity and gradually slows to a stop.Animated.spring() provides a simple spring physics model.Animated.spring() provides a basic spring physics model.Animated.timing() animates a value over time using easing functions.
In most cases, you will be using timing(). By default, it uses a symmetric easeInOut curve that conveys the gradual acceleration of an object to full speed and concludes by gradually decelerating to a stop.
@@ -100,7 +100,7 @@
By using the native driver, we send everything about the animation to native before starting the animation, allowing native code to perform the animation on the UI thread without having to go through the bridge on every frame. Once the animation has started, the JS thread can be blocked without affecting the animation.
You can use the native driver by specifying useNativeDriver: true in your animation configuration. See the Animations guide to learn more.
Animatable components
-Only animatable components can be animated. These special components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.
+Only animatable components can be animated. These unique components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.
createAnimatedComponent() can be used to make a component animatable.
@@ -119,7 +119,7 @@
Animated.sequence() starts the animations in order, waiting for each to complete before starting the next.Animated.stagger() starts animations in order and in parallel, but with successive delays.Animations can also be chained together simply by setting the toValue of one animation to be another Animated.Value. See Tracking dynamic values in the Animations guide.
+Animations can also be chained together by setting the toValue of one animation to be another Animated.Value. See Tracking dynamic values in the Animations guide.
By default, if one animation is stopped or interrupted, then all other animations in the group are also stopped.
Combining animated values
You can combine two animated values via addition, multiplication, division, or modulo to make a new animated value:
diff --git a/docs/0.49/animated/index.html b/docs/0.49/animated/index.html
index 1ee3066b506..accdee1cf0e 100644
--- a/docs/0.49/animated/index.html
+++ b/docs/0.49/animated/index.html
@@ -1,4 +1,4 @@
-Animated · React Native
EditAnimated
The Animated library is designed to make animations fluid, powerful, and easy to build and maintain. Animated focuses on declarative relationships between inputs and outputs, with configurable transforms in between, and simple start/stop methods to control time-based animation execution.
+ EditAnimated
The Animated library is designed to make animations fluid, powerful, and handy to build and maintain. Animated focuses on declarative relationships between inputs and outputs, with configurable transforms in between, and basic start/stop methods to control time-based animation execution.
The simplest workflow for creating an animation is to create an Animated.Value, hook it up to one or more style attributes of an animated component, and then drive updates via animations using Animated.timing():
Animated.timing(
// Animate value over time
@@ -90,7 +90,7 @@
Animated provides three types of animation types. Each animation type provides a particular animation curve that controls how your values animate from their initial value to the final value:
Animated.decay() starts with an initial velocity and gradually slows to a stop.Animated.spring() provides a simple spring physics model.Animated.spring() provides a basic spring physics model.Animated.timing() animates a value over time using easing functions.
In most cases, you will be using timing(). By default, it uses a symmetric easeInOut curve that conveys the gradual acceleration of an object to full speed and concludes by gradually decelerating to a stop.
@@ -100,7 +100,7 @@
By using the native driver, we send everything about the animation to native before starting the animation, allowing native code to perform the animation on the UI thread without having to go through the bridge on every frame. Once the animation has started, the JS thread can be blocked without affecting the animation.
You can use the native driver by specifying useNativeDriver: true in your animation configuration. See the Animations guide to learn more.
Animatable components
-Only animatable components can be animated. These special components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.
+Only animatable components can be animated. These unique components do the magic of binding the animated values to the properties, and do targeted native updates to avoid the cost of the react render and reconciliation process on every frame. They also handle cleanup on unmount so they are safe by default.
createAnimatedComponent() can be used to make a component animatable.
@@ -119,7 +119,7 @@
Animated.sequence() starts the animations in order, waiting for each to complete before starting the next.Animated.stagger() starts animations in order and in parallel, but with successive delays.Animations can also be chained together simply by setting the toValue of one animation to be another Animated.Value. See Tracking dynamic values in the Animations guide.
+Animations can also be chained together by setting the toValue of one animation to be another Animated.Value. See Tracking dynamic values in the Animations guide.
By default, if one animation is stopped or interrupted, then all other animations in the group are also stopped.
Combining animated values
You can combine two animated values via addition, multiplication, division, or modulo to make a new animated value:
diff --git a/docs/0.49/flatlist.html b/docs/0.49/flatlist.html
index 2edcac68053..c103cfd93cb 100644
--- a/docs/0.49/flatlist.html
+++ b/docs/0.49/flatlist.html
@@ -1,4 +1,4 @@
-FlatList · React Native
EditFlatList
A performant interface for rendering simple, flat lists, supporting the most handy features:
+ EditFlatList
A performant interface for rendering basic, flat lists, supporting the most handy features:
- Fully cross-platform.
- Optional horizontal mode.
diff --git a/docs/0.49/flatlist/index.html b/docs/0.49/flatlist/index.html
index 2edcac68053..c103cfd93cb 100644
--- a/docs/0.49/flatlist/index.html
+++ b/docs/0.49/flatlist/index.html
@@ -1,4 +1,4 @@
-FlatList · React Native
EditFlatList
A performant interface for rendering simple, flat lists, supporting the most handy features:
+ EditFlatList
A performant interface for rendering basic, flat lists, supporting the most handy features:
- Fully cross-platform.
- Optional horizontal mode.
diff --git a/docs/0.49/layout-props.html b/docs/0.49/layout-props.html
index 9e3ce950d10..f6df1df1c54 100644
--- a/docs/0.49/layout-props.html
+++ b/docs/0.49/layout-props.html
@@ -571,9 +571,9 @@
position
-position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always just relative to the parent.
+position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always relative to the parent.
If you want to position a child using specific numbers of logical pixels relative to its parent, set the child to have absolute position.
-If you want to position a child relative to something that is not its parent, just don't use styles for that. Use the component tree.
+If you want to position a child relative to something that is not its parent, don't use styles for that. Use the component tree.
See https://github.com/facebook/yoga for more details on how position differs between React Native and CSS.
diff --git a/docs/0.49/layout-props/index.html b/docs/0.49/layout-props/index.html
index 9e3ce950d10..f6df1df1c54 100644
--- a/docs/0.49/layout-props/index.html
+++ b/docs/0.49/layout-props/index.html
@@ -571,9 +571,9 @@
position
-position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always just relative to the parent.
+position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always relative to the parent.
If you want to position a child using specific numbers of logical pixels relative to its parent, set the child to have absolute position.
-If you want to position a child relative to something that is not its parent, just don't use styles for that. Use the component tree.
+If you want to position a child relative to something that is not its parent, don't use styles for that. Use the component tree.
See https://github.com/facebook/yoga for more details on how position differs between React Native and CSS.
diff --git a/docs/0.49/listview.html b/docs/0.49/listview.html
index 22f04167afb..1d0502b903e 100644
--- a/docs/0.49/listview.html
+++ b/docs/0.49/listview.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.49/listview/index.html b/docs/0.49/listview/index.html
index 22f04167afb..1d0502b903e 100644
--- a/docs/0.49/listview/index.html
+++ b/docs/0.49/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.49/listviewdatasource.html b/docs/0.49/listviewdatasource.html
index 6eb48321a2c..7ef03756260 100644
--- a/docs/0.49/listviewdatasource.html
+++ b/docs/0.49/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.49/listviewdatasource/index.html b/docs/0.49/listviewdatasource/index.html
index 6eb48321a2c..7ef03756260 100644
--- a/docs/0.49/listviewdatasource/index.html
+++ b/docs/0.49/listviewdatasource/index.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.49/modal.html b/docs/0.49/modal.html
index 8a4d7a88166..70722a84a0d 100644
--- a/docs/0.49/modal.html
+++ b/docs/0.49/modal.html
@@ -1,4 +1,4 @@
-Modal · React Native
EditModal
The Modal component is a simple way to present content above an enclosing view.
+ EditModal
The Modal component is a basic way to present content above an enclosing view.
Note: If you need more control over how to present modals over the rest of your app, then consider using a top-level Navigator.
import React, {Component} from 'react';
import {Modal, Text, TouchableHighlight, View} from 'react-native';
diff --git a/docs/0.49/modal/index.html b/docs/0.49/modal/index.html
index 8a4d7a88166..70722a84a0d 100644
--- a/docs/0.49/modal/index.html
+++ b/docs/0.49/modal/index.html
@@ -1,4 +1,4 @@
-Modal · React Native
EditModal
The Modal component is a simple way to present content above an enclosing view.
+ EditModal
The Modal component is a basic way to present content above an enclosing view.
Note: If you need more control over how to present modals over the rest of your app, then consider using a top-level Navigator.
import React, {Component} from 'react';
import {Modal, Text, TouchableHighlight, View} from 'react-native';
diff --git a/docs/0.49/navigatorios.html b/docs/0.49/navigatorios.html
index 646289b0c57..201f2bba9b7 100644
--- a/docs/0.49/navigatorios.html
+++ b/docs/0.49/navigatorios.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.49/navigatorios/index.html b/docs/0.49/navigatorios/index.html
index 646289b0c57..201f2bba9b7 100644
--- a/docs/0.49/navigatorios/index.html
+++ b/docs/0.49/navigatorios/index.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.49/scrollview.html b/docs/0.49/scrollview.html
index c2570617894..f82f6716b71 100644
--- a/docs/0.49/scrollview.html
+++ b/docs/0.49/scrollview.html
@@ -69,12 +69,12 @@
}
});
EditScrollView
Component that wraps platform ScrollView while providing integration with touch locking "responder" system.
-Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes easy to debug.
+Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes quick to debug.
Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.
<ScrollView> vs <FlatList> - which one to use?
-ScrollView simply renders all its react child components at once. That makes it very easy to understand and use.
-On the other hand, this has a performance downside. Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.
-This is where FlatList comes into play. FlatList renders items lazily, just when they are about to appear, and removes items that scroll way off screen to save memory and processing time.
+ScrollView renders all its react child components at once, but this has a performance downside.
+Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.
+This is where FlatList comes into play. FlatList renders items lazily, when they are about to appear, and removes items that scroll way off screen to save memory and processing time.
FlatList is also handy if you want to render separators between your items, multiple columns, infinite scroll loading, or any number of other features it supports out of the box.
Props
@@ -557,8 +557,8 @@ const styles = StyleSheet.create({
The style of the scroll indicators.
'default' (the default), same as black.'black', scroll indicator is black. This style is good against a light background.'white', scroll indicator is white. This style is good against a dark background.'black', scroll indicator is black. This style is good against a light background.'white', scroll indicator is white. This style is good against a dark background.
diff --git a/docs/0.49/scrollview/index.html b/docs/0.49/scrollview/index.html
index c2570617894..f82f6716b71 100644
--- a/docs/0.49/scrollview/index.html
+++ b/docs/0.49/scrollview/index.html
@@ -69,12 +69,12 @@
}
});
EditScrollView
Component that wraps platform ScrollView while providing integration with touch locking "responder" system.
-Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes easy to debug.
+Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes quick to debug.
Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.
<ScrollView> vs <FlatList> - which one to use?
-ScrollView simply renders all its react child components at once. That makes it very easy to understand and use.
-On the other hand, this has a performance downside. Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.
-This is where FlatList comes into play. FlatList renders items lazily, just when they are about to appear, and removes items that scroll way off screen to save memory and processing time.
+ScrollView renders all its react child components at once, but this has a performance downside.
+Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.
+This is where FlatList comes into play. FlatList renders items lazily, when they are about to appear, and removes items that scroll way off screen to save memory and processing time.
FlatList is also handy if you want to render separators between your items, multiple columns, infinite scroll loading, or any number of other features it supports out of the box.
Props
@@ -557,8 +557,8 @@ const styles = StyleSheet.create({
The style of the scroll indicators.
'default' (the default), same as black.'black', scroll indicator is black. This style is good against a light background.'white', scroll indicator is white. This style is good against a dark background.'black', scroll indicator is black. This style is good against a light background.'white', scroll indicator is white. This style is good against a dark background.
diff --git a/docs/0.49/sectionlist.html b/docs/0.49/sectionlist.html
index 4c3f025b5c2..a2c6698e8fb 100644
--- a/docs/0.49/sectionlist.html
+++ b/docs/0.49/sectionlist.html
@@ -82,7 +82,7 @@
- Scroll loading.
If you don't need section support and want a simpler interface, use <FlatList>.
-Simple Examples:
+Examples:
<SectionList
renderItem={({item}) => <ListItem title={item} />}
renderSectionHeader={({section}) => <Header title={section.title} />}
diff --git a/docs/0.49/sectionlist/index.html b/docs/0.49/sectionlist/index.html
index 4c3f025b5c2..a2c6698e8fb 100644
--- a/docs/0.49/sectionlist/index.html
+++ b/docs/0.49/sectionlist/index.html
@@ -82,7 +82,7 @@
- Scroll loading.
If you don't need section support and want a simpler interface, use <FlatList>.
-Simple Examples:
+Examples:
<SectionList
renderItem={({item}) => <ListItem title={item} />}
renderSectionHeader={({section}) => <Header title={section.title} />}
diff --git a/docs/0.49/tabbarios.html b/docs/0.49/tabbarios.html
index 53dfc359dbe..0756d1b7969 100644
--- a/docs/0.49/tabbarios.html
+++ b/docs/0.49/tabbarios.html
@@ -86,7 +86,7 @@
Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required In order to use this feature, you must give the view a width and a height.
Containers
-The <Text> element is special relative to layout: everything inside is no longer using the flexbox layout but using text layout. This means that elements inside of a <Text> are no longer rectangles, but wrap when they see the end of the line.
+The <Text> element is unique relative to layout: everything inside is no longer using the flexbox layout but using text layout. This means that elements inside of a <Text> are no longer rectangles, but wrap when they see the end of the line.
<Text>
<Text>First part and </Text>
<Text>second part</Text>
@@ -248,7 +248,7 @@ AppRegistry.registerComponent('AwesomeProject', () => BlueIsCool);
<MyAppHeaderText>Text styled as a header</MyAppHeaderText>
</View>
-Assuming that MyAppText is a component that simply renders out its children into a Text component with styling, then MyAppHeaderText can be defined as follows:
+Assuming that MyAppText is a component that only renders out its children into a Text component with styling, then MyAppHeaderText can be defined as follows:
class MyAppHeaderText extends Component {
render() {
<MyAppText>
diff --git a/docs/0.49/text/index.html b/docs/0.49/text/index.html
index ed2d88d6f69..2d590882e5c 100644
--- a/docs/0.49/text/index.html
+++ b/docs/0.49/text/index.html
@@ -199,7 +199,7 @@ AppRegistry.registerComponent('AwesomeProject', () => BlueIsCool);
In order to use this feature, you must give the view a width and a height.
Containers
-The <Text> element is special relative to layout: everything inside is no longer using the flexbox layout but using text layout. This means that elements inside of a <Text> are no longer rectangles, but wrap when they see the end of the line.
+The <Text> element is unique relative to layout: everything inside is no longer using the flexbox layout but using text layout. This means that elements inside of a <Text> are no longer rectangles, but wrap when they see the end of the line.
<Text>
<Text>First part and </Text>
<Text>second part</Text>
@@ -248,7 +248,7 @@ AppRegistry.registerComponent('AwesomeProject', () => BlueIsCool);
<MyAppHeaderText>Text styled as a header</MyAppHeaderText>
</View>
-Assuming that MyAppText is a component that simply renders out its children into a Text component with styling, then MyAppHeaderText can be defined as follows:
+Assuming that MyAppText is a component that only renders out its children into a Text component with styling, then MyAppHeaderText can be defined as follows:
class MyAppHeaderText extends Component {
render() {
<MyAppText>
diff --git a/docs/0.49/textinput.html b/docs/0.49/textinput.html
index 36b603633bb..857588ef930 100644
--- a/docs/0.49/textinput.html
+++ b/docs/0.49/textinput.html
@@ -69,7 +69,7 @@
}
});
EditTextInput
A foundational component for inputting text into the app via a keyboard. Props provide configurability for several features, such as auto-correction, auto-capitalization, placeholder text, and different keyboard types, such as a numeric keypad.
-The simplest use case is to plop down a TextInput and subscribe to the onChangeText events to read the user input. There are also other events, such as onSubmitEditing and onFocus that can be subscribed to. A simple example:
+The simplest use case is to plop down a TextInput and subscribe to the onChangeText events to read the user input. There are also other events, such as onSubmitEditing and onFocus that can be subscribed to. A minimal example:
defaultValue
-Provides an initial value that will change when the user starts typing. Useful for simple use-cases where you do not want to deal with listening to events and updating the value prop to keep the controlled state in sync.
+Provides an initial value that will change when the user starts typing. Useful for use-cases where you do not want to deal with listening to events and updating the value prop to keep the controlled state in sync.
Type Required
value
-The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses, this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to simply setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.
+The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses, this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.
Type Required EditTextInput
A foundational component for inputting text into the app via a keyboard. Props provide configurability for several features, such as auto-correction, auto-capitalization, placeholder text, and different keyboard types, such as a numeric keypad.
-The simplest use case is to plop down a TextInput and subscribe to the onChangeText events to read the user input. There are also other events, such as onSubmitEditing and onFocus that can be subscribed to. A simple example:
+The simplest use case is to plop down a TextInput and subscribe to the onChangeText events to read the user input. There are also other events, such as onSubmitEditing and onFocus that can be subscribed to. A minimal example:
defaultValue
-Provides an initial value that will change when the user starts typing. Useful for simple use-cases where you do not want to deal with listening to events and updating the value prop to keep the controlled state in sync.
+Provides an initial value that will change when the user starts typing. Useful for use-cases where you do not want to deal with listening to events and updating the value prop to keep the controlled state in sync.
Type Required
value
-The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses, this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to simply setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.
+The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses, this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.
Type Required There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.49/vibration/index.html b/docs/0.49/vibration/index.html
index 2b9c98be20a..7f73bf03fb0 100644
--- a/docs/0.49/vibration/index.html
+++ b/docs/0.49/vibration/index.html
@@ -72,7 +72,7 @@
There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.49/view.html b/docs/0.49/view.html
index 560a23798d6..1f622435e92 100644
--- a/docs/0.49/view.html
+++ b/docs/0.49/view.html
@@ -386,7 +386,7 @@
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform
position
-position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always just relative to the parent.
+position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always relative to the parent.
If you want to position a child using specific numbers of logical pixels relative to its parent, set the child to have absolute position.
-If you want to position a child relative to something that is not its parent, just don't use styles for that. Use the component tree.
+If you want to position a child relative to something that is not its parent, don't use styles for that. Use the component tree.
See https://github.com/facebook/yoga for more details on how position differs between React Native and CSS.
diff --git a/docs/0.50/layout-props/index.html b/docs/0.50/layout-props/index.html
index 7f85937a485..f4b3a0d2161 100644
--- a/docs/0.50/layout-props/index.html
+++ b/docs/0.50/layout-props/index.html
@@ -571,9 +571,9 @@
position
-position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always just relative to the parent.
+position in React Native is similar to regular CSS, but everything is set to relative by default, so absolute positioning is always relative to the parent.
If you want to position a child using specific numbers of logical pixels relative to its parent, set the child to have absolute position.
-If you want to position a child relative to something that is not its parent, just don't use styles for that. Use the component tree.
+If you want to position a child relative to something that is not its parent, don't use styles for that. Use the component tree.
See https://github.com/facebook/yoga for more details on how position differs between React Native and CSS.
diff --git a/docs/0.50/listview.html b/docs/0.50/listview.html
index 9c3e5c1e8e0..a45f7dbdaa1 100644
--- a/docs/0.50/listview.html
+++ b/docs/0.50/listview.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.50/listview/index.html b/docs/0.50/listview/index.html
index 9c3e5c1e8e0..a45f7dbdaa1 100644
--- a/docs/0.50/listview/index.html
+++ b/docs/0.50/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.50/listviewdatasource.html b/docs/0.50/listviewdatasource.html
index 2bf42f60676..e6518172d8a 100644
--- a/docs/0.50/listviewdatasource.html
+++ b/docs/0.50/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.50/listviewdatasource/index.html b/docs/0.50/listviewdatasource/index.html
index 2bf42f60676..e6518172d8a 100644
--- a/docs/0.50/listviewdatasource/index.html
+++ b/docs/0.50/listviewdatasource/index.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.50/navigatorios.html b/docs/0.50/navigatorios.html
index c2a40881048..2b433c2dfa5 100644
--- a/docs/0.50/navigatorios.html
+++ b/docs/0.50/navigatorios.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.50/navigatorios/index.html b/docs/0.50/navigatorios/index.html
index c2a40881048..2b433c2dfa5 100644
--- a/docs/0.50/navigatorios/index.html
+++ b/docs/0.50/navigatorios/index.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.50/tabbarios.html b/docs/0.50/tabbarios.html
index 461f2d18593..f64cd4e3fda 100644
--- a/docs/0.50/tabbarios.html
+++ b/docs/0.50/tabbarios.html
@@ -86,7 +86,7 @@
Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.50/vibration/index.html b/docs/0.50/vibration/index.html
index 325091e2d2b..2db3f2e8a20 100644
--- a/docs/0.50/vibration/index.html
+++ b/docs/0.50/vibration/index.html
@@ -72,7 +72,7 @@
There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.50/view.html b/docs/0.50/view.html
index f3cf3ece07a..21a3c8ddae4 100644
--- a/docs/0.50/view.html
+++ b/docs/0.50/view.html
@@ -386,7 +386,7 @@
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.51/listview/index.html b/docs/0.51/listview/index.html
index db3c63731bb..a891a4de085 100644
--- a/docs/0.51/listview/index.html
+++ b/docs/0.51/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.51/listviewdatasource.html b/docs/0.51/listviewdatasource.html
index 3bb863ee53d..9256b208dd5 100644
--- a/docs/0.51/listviewdatasource.html
+++ b/docs/0.51/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.51/listviewdatasource/index.html b/docs/0.51/listviewdatasource/index.html
index 3bb863ee53d..9256b208dd5 100644
--- a/docs/0.51/listviewdatasource/index.html
+++ b/docs/0.51/listviewdatasource/index.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.51/navigatorios.html b/docs/0.51/navigatorios.html
index c827ba9733f..6d6d1f672b1 100644
--- a/docs/0.51/navigatorios.html
+++ b/docs/0.51/navigatorios.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.51/navigatorios/index.html b/docs/0.51/navigatorios/index.html
index c827ba9733f..6d6d1f672b1 100644
--- a/docs/0.51/navigatorios/index.html
+++ b/docs/0.51/navigatorios/index.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.51/tabbarios.html b/docs/0.51/tabbarios.html
index 03ac8b34846..53e0434643a 100644
--- a/docs/0.51/tabbarios.html
+++ b/docs/0.51/tabbarios.html
@@ -86,7 +86,7 @@
Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.51/vibration/index.html b/docs/0.51/vibration/index.html
index 6629b97f72e..ed2d3e5854d 100644
--- a/docs/0.51/vibration/index.html
+++ b/docs/0.51/vibration/index.html
@@ -72,7 +72,7 @@
There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.51/view.html b/docs/0.51/view.html
index 749d27d0d4c..f138a592758 100644
--- a/docs/0.51/view.html
+++ b/docs/0.51/view.html
@@ -386,7 +386,7 @@
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.52/listview/index.html b/docs/0.52/listview/index.html
index 3f1b12810ba..c64a3db6e52 100644
--- a/docs/0.52/listview/index.html
+++ b/docs/0.52/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.52/listviewdatasource.html b/docs/0.52/listviewdatasource.html
index d76b63e1641..0c1fbd0c63e 100644
--- a/docs/0.52/listviewdatasource.html
+++ b/docs/0.52/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.52/listviewdatasource/index.html b/docs/0.52/listviewdatasource/index.html
index d76b63e1641..0c1fbd0c63e 100644
--- a/docs/0.52/listviewdatasource/index.html
+++ b/docs/0.52/listviewdatasource/index.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.52/navigatorios.html b/docs/0.52/navigatorios.html
index 96887ccb37b..fe273c9f80e 100644
--- a/docs/0.52/navigatorios.html
+++ b/docs/0.52/navigatorios.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.52/navigatorios/index.html b/docs/0.52/navigatorios/index.html
index 96887ccb37b..fe273c9f80e 100644
--- a/docs/0.52/navigatorios/index.html
+++ b/docs/0.52/navigatorios/index.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.52/tabbarios.html b/docs/0.52/tabbarios.html
index 87194b347e6..8a713abe6ee 100644
--- a/docs/0.52/tabbarios.html
+++ b/docs/0.52/tabbarios.html
@@ -86,7 +86,7 @@
Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.52/vibration/index.html b/docs/0.52/vibration/index.html
index 19daaea95cf..d702b09ad67 100644
--- a/docs/0.52/vibration/index.html
+++ b/docs/0.52/vibration/index.html
@@ -72,7 +72,7 @@
There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.52/view.html b/docs/0.52/view.html
index 1e844d69bf4..e2e5838a244 100644
--- a/docs/0.52/view.html
+++ b/docs/0.52/view.html
@@ -386,7 +386,7 @@
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.53/listview/index.html b/docs/0.53/listview/index.html
index d35bc01e830..bf9f97aa6e3 100644
--- a/docs/0.53/listview/index.html
+++ b/docs/0.53/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.53/listviewdatasource.html b/docs/0.53/listviewdatasource.html
index 9d48d34ec70..5d96c9f8ba9 100644
--- a/docs/0.53/listviewdatasource.html
+++ b/docs/0.53/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.53/listviewdatasource/index.html b/docs/0.53/listviewdatasource/index.html
index 9d48d34ec70..5d96c9f8ba9 100644
--- a/docs/0.53/listviewdatasource/index.html
+++ b/docs/0.53/listviewdatasource/index.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.53/navigatorios.html b/docs/0.53/navigatorios.html
index 70df3ec64ca..0c44821893f 100644
--- a/docs/0.53/navigatorios.html
+++ b/docs/0.53/navigatorios.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.53/navigatorios/index.html b/docs/0.53/navigatorios/index.html
index 70df3ec64ca..0c44821893f 100644
--- a/docs/0.53/navigatorios/index.html
+++ b/docs/0.53/navigatorios/index.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.53/tabbarios.html b/docs/0.53/tabbarios.html
index ec8c932237a..371ee60c5ae 100644
--- a/docs/0.53/tabbarios.html
+++ b/docs/0.53/tabbarios.html
@@ -86,7 +86,7 @@
Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.53/vibration/index.html b/docs/0.53/vibration/index.html
index 36462fefe90..90660c7661a 100644
--- a/docs/0.53/vibration/index.html
+++ b/docs/0.53/vibration/index.html
@@ -72,7 +72,7 @@
There will be no effect on devices that do not support Vibration, eg. the simulator.
Note for Android: add <uses-permission android:name="android.permission.VIBRATE"/> to AndroidManifest.xml
Since the vibration duration in iOS is not configurable, so there are some differences with Android. In Android, if pattern is a number, it specified the vibration duration in ms. If pattern is an array, those odd indices is the vibration duration, while the even one are the separation time.
-In iOS, invoking vibrate(duration) will just ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
+In iOS, invoking vibrate(duration) will ignore the duration and vibrate for a fixed time. While the pattern array is used to define the duration between each vibration. See below example for more.
Repeatable vibration is also supported, the vibration will repeat with defined pattern until cancel() is called.
Example:
const DURATION = 10000
diff --git a/docs/0.53/view.html b/docs/0.53/view.html
index 2c51c0032a1..7fc3f2de5d9 100644
--- a/docs/0.53/view.html
+++ b/docs/0.53/view.html
@@ -386,7 +386,7 @@
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.54/listview/index.html b/docs/0.54/listview/index.html
index 2da1f4aac47..46421d89f7f 100644
--- a/docs/0.54/listview/index.html
+++ b/docs/0.54/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.54/listviewdatasource.html b/docs/0.54/listviewdatasource.html
index 3bce1724cc4..8f5cb454cda 100644
--- a/docs/0.54/listviewdatasource.html
+++ b/docs/0.54/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.54/listviewdatasource/index.html b/docs/0.54/listviewdatasource/index.html
index 3bce1724cc4..8f5cb454cda 100644
--- a/docs/0.54/listviewdatasource/index.html
+++ b/docs/0.54/listviewdatasource/index.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.54/navigatorios.html b/docs/0.54/navigatorios.html
index 4fdc51fdfaf..73eac7fe531 100644
--- a/docs/0.54/navigatorios.html
+++ b/docs/0.54/navigatorios.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.54/navigatorios/index.html b/docs/0.54/navigatorios/index.html
index 4fdc51fdfaf..73eac7fe531 100644
--- a/docs/0.54/navigatorios/index.html
+++ b/docs/0.54/navigatorios/index.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.54/tabbarios.html b/docs/0.54/tabbarios.html
index 4cba5fcf540..564cdf083dc 100644
--- a/docs/0.54/tabbarios.html
+++ b/docs/0.54/tabbarios.html
@@ -86,7 +86,7 @@
Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform
removeClippedSubviews
-This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
Type Required
renderToHardwareTextureAndroid
Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.
-On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
Type Required Platform EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.55/listview/index.html b/docs/0.55/listview/index.html
index de83e57ae29..e3574ad7be7 100644
--- a/docs/0.55/listview/index.html
+++ b/docs/0.55/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.55/listviewdatasource.html b/docs/0.55/listviewdatasource.html
index ab8ea357ccc..79948dbac9f 100644
--- a/docs/0.55/listviewdatasource.html
+++ b/docs/0.55/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.55/listviewdatasource/index.html b/docs/0.55/listviewdatasource/index.html
index ab8ea357ccc..79948dbac9f 100644
--- a/docs/0.55/listviewdatasource/index.html
+++ b/docs/0.55/listviewdatasource/index.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.55/navigatorios.html b/docs/0.55/navigatorios.html
index ebae70db0ca..be6fa82adc2 100644
--- a/docs/0.55/navigatorios.html
+++ b/docs/0.55/navigatorios.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.55/navigatorios/index.html b/docs/0.55/navigatorios/index.html
index ebae70db0ca..be6fa82adc2 100644
--- a/docs/0.55/navigatorios/index.html
+++ b/docs/0.55/navigatorios/index.html
@@ -239,7 +239,7 @@ render() {
barStyle
-The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
+The style of the navigation bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a navigation bar with the native iOS style with higher translucency.
Type Required
interactivePopGestureEnabled
-Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
+Boolean value that indicates whether the interactive pop gesture is enabled. This is useful for enabling/disabling the back swipe navigation gesture.
If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
@@ -369,7 +369,7 @@ render() {
pop()
pop();
-Pop back to the previous scene.
+Pop back to the previous scene.
replaceAtIndex()
replaceAtIndex((route: object), (index: number));
@@ -450,7 +450,7 @@ render() {
resetTo()
resetTo((route: object));
-Replaces the top item and pop to it.
+Replaces the top item and pop to it.
Parameters:
diff --git a/docs/0.55/tabbarios.html b/docs/0.55/tabbarios.html
index 96ca23e0474..7181ff9e5d4 100644
--- a/docs/0.55/tabbarios.html
+++ b/docs/0.55/tabbarios.html
@@ -86,7 +86,7 @@
Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.56/listview/index.html b/docs/0.56/listview/index.html
index 6583a2aa6b2..c4f62f1efea 100644
--- a/docs/0.56/listview/index.html
+++ b/docs/0.56/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.56/listviewdatasource.html b/docs/0.56/listviewdatasource.html
index ac85e2b8d2d..540abc66af2 100644
--- a/docs/0.56/listviewdatasource.html
+++ b/docs/0.56/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.56/listviewdatasource/index.html b/docs/0.56/listviewdatasource/index.html
index ac85e2b8d2d..540abc66af2 100644
--- a/docs/0.56/listviewdatasource/index.html
+++ b/docs/0.56/listviewdatasource/index.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {
cloneWithRows()
cloneWithRows(dataBlob, rowIdentities);
-Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is just an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
+Clones this ListViewDataSource with the specified dataBlob and rowIdentities. The dataBlob is only an arbitrary blob of data. At construction an extractor to get the interesting information was defined (or the default was used).
The rowIdentities is a 2D array of identifiers for rows. ie. [['a1', 'a2'], ['b1', 'b2', 'b3'], ...]. If not provided, it's assumed that the keys of the section data are the row identities.
-Note: This function does NOT clone the data in this data source. It simply passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
+Note: This function does NOT clone the data in this data source. It passes the functions defined at construction to a new data source with the data specified. If you wish to maintain the existing data you must handle merging of old and new data separately and then pass that into this function as the dataBlob.
cloneWithRowsAndSections()
cloneWithRowsAndSections(dataBlob, sectionIdentities, rowIdentities);
diff --git a/docs/0.56/tabbarios.html b/docs/0.56/tabbarios.html
index 3187138aea7..3a8c6235fc8 100644
--- a/docs/0.56/tabbarios.html
+++ b/docs/0.56/tabbarios.html
@@ -86,7 +86,7 @@
Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required Reference
Props
barStyle
-The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
+The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.
Type Required EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.57/listview/index.html b/docs/0.57/listview/index.html
index af859c16222..8c4dcdcbf25 100644
--- a/docs/0.57/listview/index.html
+++ b/docs/0.57/listview/index.html
@@ -69,7 +69,7 @@
}
});
EditListView
DEPRECATED - use one of the new list components, such as FlatList or SectionList for bounded memory use, fewer bugs, better performance, an easier to use API, and more features. Check out this blog post for more details.
-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 callback which takes a blob from the data array and returns a renderable component.
+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 basic array of data blobs, and instantiate a ListView component with that data source and a renderRow callback which takes a blob from the data array and returns a renderable component.
Minimal example:
class MyComponent extends Component {
constructor() {
diff --git a/docs/0.57/listviewdatasource.html b/docs/0.57/listviewdatasource.html
index 87284472873..70409eb11fb 100644
--- a/docs/0.57/listviewdatasource.html
+++ b/docs/0.57/listviewdatasource.html
@@ -1,4 +1,4 @@
-ListViewDataSource · React Native
EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be as simple as an array of strings, or an object with rows nested inside section objects.
-To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods suck in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
+ EditListViewDataSource
Provides efficient data processing and access to the ListView component. A ListViewDataSource is created with functions for extracting data from the input blob, and comparing elements (with default implementations for convenience). The input blob can be an array of strings, or an object with rows nested inside section objects.
+To update the data in the datasource, use cloneWithRows (or cloneWithRowsAndSections if you care about sections). The data in the data source is immutable, so you can't modify it directly. The clone methods takes in the new data and compute a diff for each row so ListView knows whether to re-render it or not.
In this example, a component receives data in chunks, handled by _onDataArrived, which concats the new data onto the old data and updates the data source. We use concat to create a new array - mutating this._data, e.g. with this._data.push(newRowData), would be an error. _rowHasChanged understands the shape of the row data and knows how to efficiently compare it.
getInitialState: function() {
var ds = new ListView.DataSource({rowHasChanged: this._rowHasChanged});
@@ -124,9 +124,9 @@ _onDataArrived(newData) {