diff --git a/releases/next/docs/listview.html b/releases/next/docs/listview.html index 71d591b8c9c..efa47f2dd78 100644 --- a/releases/next/docs/listview.html +++ b/releases/next/docs/listview.html @@ -60,7 +60,7 @@ header.

scrollRenderAheadDistance number #

How early to start rendering rows before they come on screen, in -pixels.

iosstickyHeaderIndices [number] #

An array of child indices determining which children get docked to the +pixels.

iosstickyHeaderIndices [number] #

An array of child indices determining which children get docked to the top of the screen when scrolling. For example, passing stickyHeaderIndices={[0]} will cause the first child to be fixed to the top of the scroll view. This property is not supported in conjunction diff --git a/releases/next/docs/mapview.html b/releases/next/docs/mapview.html index 97ba3fd6152..9c975b80ab7 100644 --- a/releases/next/docs/mapview.html +++ b/releases/next/docs/mapview.html @@ -12,7 +12,7 @@ Default value is true.

style View#style #

Used to style and layout the MapView. See StyleSheet.js and ViewStylePropTypes.js for more info.

zoomEnabled bool #

If false the user won't be able to pinch/zoom the map. -Default value is true.

androidactive bool #

iosannotations [{latitude: number, longitude: number, animateDrop: bool, draggable: bool, onDragStateChange: function, onFocus: function, onBlur: function, title: string, subtitle: string, leftCalloutView: element, rightCalloutView: element, detailCalloutView: element, tintColor: [object Object], image: Image.propTypes.source, view: element, id: string, hasLeftCallout: deprecatedPropType( +Default value is true.

androidactive bool #

iosannotations [{latitude: number, longitude: number, animateDrop: bool, draggable: bool, onDragStateChange: function, onFocus: function, onBlur: function, title: string, subtitle: string, leftCalloutView: element, rightCalloutView: element, detailCalloutView: element, tintColor: [object Object], image: Image.propTypes.source, view: element, id: string, hasLeftCallout: deprecatedPropType( React.PropTypes.bool, 'Use `leftCalloutView` instead.' ), hasRightCallout: deprecatedPropType( @@ -24,10 +24,10 @@ Default value is true.

#

Map annotations with title/subtitle.

iosfollowUserLocation bool #

If true the map will follow the user's location whenever it changes. +)}] #

Map annotations with title/subtitle.

iosfollowUserLocation bool #

If true the map will follow the user's location whenever it changes. Note that this has no effect unless showsUserLocation is enabled. Default value is true.

ioslegalLabelInsets {top: number, left: number, bottom: number, right: number} #

Insets for the map's legal label, originally at bottom left of the map. -See EdgeInsetsPropType.js for more information.

iosmapType enum('standard', 'satellite', 'hybrid') #

The map type to be displayed.

  • standard: standard road map (default)
  • satellite: satellite view
  • hybrid: satellite view with roads and points of interest overlaid

iosmaxDelta number #

Maximum size of area that can be displayed.

iosminDelta number #

Minimum size of area that can be displayed.

iosoverlays [{coordinates: [{latitude: number, longitude: number}], lineWidth: number, strokeColor: [object Object], fillColor: [object Object], id: string}] #

Map overlays

iosshowsCompass bool #

If false compass won't be displayed on the map. +See EdgeInsetsPropType.js for more information.

iosmapType enum('standard', 'satellite', 'hybrid') #

The map type to be displayed.

  • standard: standard road map (default)
  • satellite: satellite view
  • hybrid: satellite view with roads and points of interest overlaid

iosmaxDelta number #

Maximum size of area that can be displayed.

iosminDelta number #

Minimum size of area that can be displayed.

iosoverlays [{coordinates: [object Object], lineWidth: number, strokeColor: [object Object], fillColor: [object Object], id: string}] #

Map overlays

iosshowsCompass bool #

If false compass won't be displayed on the map. Default value is true.

iosshowsPointsOfInterest bool #

If false points of interest won't be displayed on the map. Default value is true.

Examples #

Edit on GitHub
'use strict'; diff --git a/releases/next/docs/navigator.html b/releases/next/docs/navigator.html index 6f7b257daf9..343d547033e 100644 --- a/releases/next/docs/navigator.html +++ b/releases/next/docs/navigator.html @@ -33,7 +33,7 @@ gestures. Will be invoked with the route and the routeStack and should return a scene configuration object

(route, routeStack) => Navigator.SceneConfigs.FloatFromRight

initialRoute object #

Specify a route to start on. A route is an object that the navigator will use to identify each scene to render. initialRoute must be a route in the initialRouteStack if both props are provided. The -initialRoute will default to the last item in the initialRouteStack.

initialRouteStack [object] #

Provide a set of routes to initially mount. Required if no initialRoute +initialRoute will default to the last item in the initialRouteStack.

initialRouteStack [object] #

Provide a set of routes to initially mount. Required if no initialRoute is provided. Otherwise, it will default to an array containing only the initialRoute

navigationBar node #

Optionally provide a navigation bar that persists across scene transitions

navigator object #

Optionally provide the navigator object from a parent Navigator

onDidFocus function #

Will be called with the new route of each scene after the transition is diff --git a/releases/next/docs/refreshcontrol.html b/releases/next/docs/refreshcontrol.html index d23a07abd59..1cdb1121ab1 100644 --- a/releases/next/docs/refreshcontrol.html +++ b/releases/next/docs/refreshcontrol.html @@ -1,6 +1,38 @@ -RefreshControl – React Native | A framework for building native apps using React

React Nativenext

Quick Start

Guides

Guides (iOS)

Guides (Android)

components

apis

Polyfills

RefreshControl #

Edit on GitHub

This component is used inside a ScrollView to add pull to refresh +RefreshControl – React Native | A framework for building native apps using React

React Nativenext

Quick Start

Guides

Guides (iOS)

Guides (Android)

components

apis

Polyfills

RefreshControl #

Edit on GitHub

This component is used inside a ScrollView or ListView to add pull to refresh functionality. When the ScrollView is at scrollY: 0, swiping down -triggers an onRefresh event.

Props #

View props... #

onRefresh function #

Called when the view starts refreshing.

refreshing bool #

Whether the view should be indicating an active refresh.

androidcolors [[object Object]] #

The colors (at least one) that will be used to draw the refresh indicator.

androidenabled bool #

Whether the pull to refresh functionality is enabled.

androidprogressBackgroundColor color #

The background color of the refresh indicator.

androidsize RefreshLayoutConsts.SIZE.DEFAULT #

Size of the refresh indicator, see RefreshControl.SIZE.

iostintColor color #

The color of the refresh indicator.

iostitle string #

The title displayed under the refresh indicator.

Examples #

Edit on GitHub
'use strict'; +triggers an onRefresh event.

Usage example #

class RefreshableList extends Component { + constructor(props) { + super(props); + this.state = { + refreshing: false, + }; + } + + _onRefresh() { + this.setState({refreshing: true}); + fetchData().then(() => { + this.setState({refreshing: false}); + }); + } + + render() { + return ( + <ListView + refreshControl={ + <RefreshControl + refreshing={this.state.refreshing} + onRefresh={this._onRefresh.bind(this)} + /> + } + ... + > + ... + </ListView> + ); + } + ... +}

Note: refreshing is a controlled prop, this is why it needs to be set to true +in the onRefresh function otherwise the refresh indicator will stop immediatly.

Props #

View props... #

onRefresh function #

Called when the view starts refreshing.

refreshing bool #

Whether the view should be indicating an active refresh.

androidcolors [color] #

The colors (at least one) that will be used to draw the refresh indicator.

androidenabled bool #

Whether the pull to refresh functionality is enabled.

androidprogressBackgroundColor color #

The background color of the refresh indicator.

androidsize RefreshLayoutConsts.SIZE.DEFAULT #

Size of the refresh indicator, see RefreshControl.SIZE.

iostintColor color #

The color of the refresh indicator.

iostitle string #

The title displayed under the refresh indicator.

Examples #

Edit on GitHub
'use strict'; const React = require('react-native'); const { diff --git a/releases/next/docs/scrollview.html b/releases/next/docs/scrollview.html index 455c9598a07..9eb01f2d0a2 100644 --- a/releases/next/docs/scrollview.html +++ b/releases/next/docs/scrollview.html @@ -82,7 +82,7 @@ of the snapping to the scroll view. - end will align the snap at the right (horizontal) or bottom (vertical)

iossnapToInterval number #

When set, causes the scroll view to stop at multiples of the value of snapToInterval. This can be used for paginating through children that have lengths smaller than the scroll view. Used in combination -with snapToAlignment.

iosstickyHeaderIndices [number] #

An array of child indices determining which children get docked to the +with snapToAlignment.

iosstickyHeaderIndices [number] #

An array of child indices determining which children get docked to the top of the screen when scrolling. For example, passing stickyHeaderIndices={[0]} will cause the first child to be fixed to the top of the scroll view. This property is not supported in conjunction diff --git a/releases/next/docs/segmentedcontrolios.html b/releases/next/docs/segmentedcontrolios.html index 31f09b101bc..a6049e53795 100644 --- a/releases/next/docs/segmentedcontrolios.html +++ b/releases/next/docs/segmentedcontrolios.html @@ -2,7 +2,7 @@ Default value is true.

momentary bool #

If true, then selecting a segment won't persist visually. The onValueChange callback will still work as expected.

onChange function #

Callback that is called when the user taps a segment; passes the event as an argument

onValueChange function #

Callback that is called when the user taps a segment; -passes the segment's value as an argument

selectedIndex number #

The index in props.values of the segment to be pre-selected

tintColor string #

Accent color of the control.

values [string] #

The labels for the control's segment buttons, in order.

Examples #

Edit on GitHub
'use strict'; +passes the segment's value as an argument

selectedIndex number #

The index in props.values of the segment to be pre-selected

tintColor string #

Accent color of the control.

values [string] #

The labels for the control's segment buttons, in order.

Examples #

Edit on GitHub
'use strict'; var React = require('react-native'); var { diff --git a/releases/next/docs/toolbarandroid.html b/releases/next/docs/toolbarandroid.html index f9e4e4e8182..c3327ead1d3 100644 --- a/releases/next/docs/toolbarandroid.html +++ b/releases/next/docs/toolbarandroid.html @@ -18,7 +18,7 @@ onActionSelected: if (position === 0) { // index of 'Settings' showSettings(); } -}

Props #

View props... #

actions [{title: string, icon: optionalImageSource, show: enum('always', 'ifRoom', 'never'), showWithText: bool}] #

Sets possible actions on the toolbar as part of the action menu. These are displayed as icons +}

Props #

View props... #

actions [{title: string, icon: optionalImageSource, show: enum('always', 'ifRoom', 'never'), showWithText: bool}] #

Sets possible actions on the toolbar as part of the action menu. These are displayed as icons or text on the right side of the widget. If they don't fit they are placed in an 'overflow' menu.

This property takes an array of objects, where each object has the following keys:

  • title: required, the title of this action
  • icon: the icon for this action, e.g. require('./some_icon.png')
  • show: when to show this action as an icon or hide it in the overflow menu: always, ifRoom or never
  • showWithText: boolean, whether to show text alongside the icon or not

contentInsetEnd number #

Sets the content inset for the toolbar ending edge.

The content inset affects the valid area for Toolbar content other than diff --git a/releases/next/docs/touchablewithoutfeedback.html b/releases/next/docs/touchablewithoutfeedback.html index 1fb59ad61fd..02d59a87931 100644 --- a/releases/next/docs/touchablewithoutfeedback.html +++ b/releases/next/docs/touchablewithoutfeedback.html @@ -1,6 +1,6 @@ TouchableWithoutFeedback – React Native | A framework for building native apps using React

React Nativenext

Quick Start

Guides

Guides (iOS)

Guides (Android)

components

apis

Polyfills

TouchableWithoutFeedback #

Edit on GitHub

Do not use unless you have a very good reason. All the elements that respond to press should have a visual feedback when touched. This is -one of the primary reason a "web" app doesn't feel "native".

NOTE: TouchableWithoutFeedback supports only one child

If you wish to have several child components, wrap them in a View.

Props #

accessibilityComponentType View.AccessibilityComponentType #

accessibilityTraits View.AccessibilityTraits, [View.AccessibilityTraits] #

accessible bool #

delayLongPress number #

Delay in ms, from onPressIn, before onLongPress is called.

delayPressIn number #

Delay in ms, from the start of the touch, before onPressIn is called.

delayPressOut number #

Delay in ms, from the release of the touch, before onPressOut is called.

disabled bool #

If true, disable all interactions for this component.

hitSlop {top: number, left: number, bottom: number, right: number} #

This defines how far your touch can start away from the button. This is +one of the primary reason a "web" app doesn't feel "native".

NOTE: TouchableWithoutFeedback supports only one child

If you wish to have several child components, wrap them in a View.

Props #

accessibilityComponentType View.AccessibilityComponentType #

accessibilityTraits View.AccessibilityTraits, [object Object] #

accessible bool #

delayLongPress number #

Delay in ms, from onPressIn, before onLongPress is called.

delayPressIn number #

Delay in ms, from the start of the touch, before onPressIn is called.

delayPressOut number #

Delay in ms, from the release of the touch, before onPressOut is called.

disabled bool #

If true, disable all interactions for this component.

hitSlop {top: number, left: number, bottom: number, right: number} #

This defines how far your touch can start away from the button. This is added to pressRetentionOffset when moving off of the button. NOTE The touch area never extends past the parent view bounds and the Z-index diff --git a/releases/next/docs/transforms.html b/releases/next/docs/transforms.html index 1c03944ed6f..f7420047259 100644 --- a/releases/next/docs/transforms.html +++ b/releases/next/docs/transforms.html @@ -1,4 +1,4 @@ -Transforms – React Native | A framework for building native apps using React

React Nativenext

Quick Start

Guides

Guides (iOS)

Guides (Android)

components

apis

Polyfills

Transforms #

Edit on GitHub

Props #

transform [{perspective: number}, {rotate: string}, {rotateX: string}, {rotateY: string}, {rotateZ: string}, {scale: number}, {scaleX: number}, {scaleY: number}, {translateX: number}, {translateY: number}, {skewX: string}, {skewY: string}] #

transformMatrix TransformMatrixPropType #

Next →
© 2016 Facebook Inc.
React Nativenext

Quick Start

Guides

Guides (iOS)

Guides (Android)

components

apis

Polyfills

Transforms #

Edit on GitHub

Props #

transform [{perspective: number}, {rotate: string}, {rotateX: string}, {rotateY: string}, {rotateZ: string}, {scale: number}, {scaleX: number}, {scaleY: number}, {translateX: number}, {translateY: number}, {skewX: string}, {skewY: string}] #

transformMatrix TransformMatrixPropType #

Next →
© 2016 Facebook Inc.