diff --git a/docs/activityindicatorios.html b/docs/activityindicatorios.html index 7f958197fb7..35c14ac1a9b 100644 --- a/docs/activityindicatorios.html +++ b/docs/activityindicatorios.html @@ -1,4 +1,4 @@ -ActivityIndicatorIOS – React Native | A framework for building native apps using React

ActivityIndicatorIOS

Edit on GitHubProps #

animating bool #

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

color string #

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

hidesWhenStopped bool #

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

onLayout function #

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

size enum('small', 'large') #

Size of the indicator. Small has a height of 20, large has a height of 36.

Edit on GitHubExamples #

'use strict'; +ActivityIndicatorIOS – React Native | A framework for building native apps using React

ActivityIndicatorIOS

Edit on GitHubProps #

animating bool #

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

color string #

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

hidesWhenStopped bool #

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

onLayout function #

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

size enum('small', 'large') #

Size of the indicator. Small has a height of 20, large has a height of 36.

Edit on GitHubExamples #

'use strict'; var React = require('react-native'); var { diff --git a/docs/datepickerios.html b/docs/datepickerios.html index 8da492562d6..6bd86b91d2a 100644 --- a/docs/datepickerios.html +++ b/docs/datepickerios.html @@ -2,7 +2,7 @@ a controlled component, so you must hook in to the onDateChange callback and update the date prop in order for the component to update, otherwise the user's change will be reverted immediately to reflect props.date as the -source of truth.

Edit on GitHubProps #

date Date #

The currently selected date.

maximumDate Date #

Maximum date.

Restricts the range of possible date/time values.

minimumDate Date #

Minimum date.

Restricts the range of possible date/time values.

minuteInterval enum(1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30) #

The interval at which minutes can be selected.

mode enum('date', 'time', 'datetime') #

The date picker mode.

onDateChange function #

Date change handler.

This is called when the user changes the date or time in the UI. +source of truth.

Edit on GitHubProps #

date Date #

The currently selected date.

maximumDate Date #

Maximum date.

Restricts the range of possible date/time values.

minimumDate Date #

Minimum date.

Restricts the range of possible date/time values.

minuteInterval enum(1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30) #

The interval at which minutes can be selected.

mode enum('date', 'time', 'datetime') #

The date picker mode.

onDateChange function #

Date change handler.

This is called when the user changes the date or time in the UI. The first and only argument is a Date object representing the new date and time.

timeZoneOffsetInMinutes number #

Timezone offset in minutes.

By default, the date picker will use the device's timezone. With this parameter, it is possible to force a certain timezone offset. For diff --git a/docs/mapview.html b/docs/mapview.html index 41f35d45d30..9cd7fda6936 100644 --- a/docs/mapview.html +++ b/docs/mapview.html @@ -1,4 +1,4 @@ -MapView – React Native | A framework for building native apps using React

MapView

Edit on GitHubProps #

annotations [{latitude: number, longitude: number, animateDrop: bool, title: string, subtitle: string, hasLeftCallout: bool, hasRightCallout: bool, onLeftCalloutPress: function, onRightCalloutPress: function, id: string}] #

Map annotations with title/subtitle.

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

Insets for the map's legal label, originally at bottom left of the map. +MapView – React Native | A framework for building native apps using React

MapView

Edit on GitHubProps #

annotations [{latitude: number, longitude: number, animateDrop: bool, title: string, subtitle: string, hasLeftCallout: bool, hasRightCallout: bool, onLeftCalloutPress: function, onRightCalloutPress: function, id: string}] #

Map annotations with title/subtitle.

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

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

mapType 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 overlayed

maxDelta number #

Maximum size of area that can be displayed.

minDelta number #

Minimum size of area that can be displayed.

onAnnotationPress function #

Callback that is called once, when the user taps an annotation.

onRegionChange function #

Callback that is called continuously when the user is dragging the map.

onRegionChangeComplete function #

Callback that is called once, when the user is done moving the map.

pitchEnabled bool #

When this property is set to true and a valid camera is associated with the map, the camera’s pitch angle is used to tilt the plane of the map. When this property is set to false, the camera’s pitch diff --git a/docs/pickerios.html b/docs/pickerios.html index 98ba4aa8ef0..18128906529 100644 --- a/docs/pickerios.html +++ b/docs/pickerios.html @@ -1,4 +1,4 @@ -PickerIOS – React Native | A framework for building native apps using React

PickerIOS

Edit on GitHubProps #

onValueChange function #

selectedValue any #

Edit on GitHubExamples #

'use strict'; +PickerIOS – React Native | A framework for building native apps using React

PickerIOS

Edit on GitHubProps #

onValueChange function #

selectedValue any #

Edit on GitHubExamples #

'use strict'; var React = require('react-native'); var { diff --git a/docs/progressbarandroid.html b/docs/progressbarandroid.html index 6f6d2d9966d..fc4461e5d2f 100644 --- a/docs/progressbarandroid.html +++ b/docs/progressbarandroid.html @@ -12,7 +12,7 @@ that the app is loading or there is some activity in the app.

Example:

style={styles.loadingComponent} /> ); -},

Edit on GitHubProps #

color string #

Color of the progress bar.

indeterminate indeterminateType #

If the progress bar will show indeterminate progress. Note that this +},

Edit on GitHubProps #

color string #

Color of the progress bar.

indeterminate indeterminateType #

If the progress bar will show indeterminate progress. Note that this can only be false if styleAttr is Horizontal.

progress number #

The progress value (between 0 and 1).

styleAttr STYLE_ATTRIBUTES #

Style of the ProgressBar. One of:

  • Horizontal
  • Small
  • Large
  • Inverse
  • SmallInverse
  • LargeInverse

testID string #

Used to locate this view in end-to-end tests.

Edit on GitHubExamples #

'use strict'; var ProgressBar = require('ProgressBarAndroid'); diff --git a/docs/progressviewios.html b/docs/progressviewios.html index a275da55fc0..49c742c4fb2 100644 --- a/docs/progressviewios.html +++ b/docs/progressviewios.html @@ -1,4 +1,4 @@ -ProgressViewIOS – React Native | A framework for building native apps using React

ProgressViewIOS

Use ProgressViewIOS to render a UIProgressView on iOS.

Edit on GitHubProps #

progress number #

The progress value (between 0 and 1).

progressImage Image.propTypes.source #

A stretchable image to display as the progress bar.

progressTintColor string #

The tint color of the progress bar itself.

progressViewStyle enum('default', 'bar') #

The progress bar style.

trackImage Image.propTypes.source #

A stretchable image to display behind the progress bar.

trackTintColor string #

The tint color of the progress bar track.

Edit on GitHubExamples #

'use strict'; +ProgressViewIOS – React Native | A framework for building native apps using React

ProgressViewIOS

Use ProgressViewIOS to render a UIProgressView on iOS.

Edit on GitHubProps #

progress number #

The progress value (between 0 and 1).

progressImage Image.propTypes.source #

A stretchable image to display as the progress bar.

progressTintColor string #

The tint color of the progress bar itself.

progressViewStyle enum('default', 'bar') #

The progress bar style.

trackImage Image.propTypes.source #

A stretchable image to display behind the progress bar.

trackTintColor string #

The tint color of the progress bar track.

Edit on GitHubExamples #

'use strict'; var React = require('react-native'); var { diff --git a/docs/segmentedcontrolios.html b/docs/segmentedcontrolios.html index b49565268f1..fa80462053b 100644 --- a/docs/segmentedcontrolios.html +++ b/docs/segmentedcontrolios.html @@ -1,4 +1,4 @@ -SegmentedControlIOS – React Native | A framework for building native apps using React

SegmentedControlIOS

Use SegmentedControlIOS to render a UISegmentedControl iOS.

Edit on GitHubProps #

enabled bool #

If false the user won't be able to interact with the control. +SegmentedControlIOS – React Native | A framework for building native apps using React

SegmentedControlIOS

Use SegmentedControlIOS to render a UISegmentedControl iOS.

Edit on GitHubProps #

enabled bool #

If false the user won't be able to interact with the control. 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; diff --git a/docs/sliderios.html b/docs/sliderios.html index 5047490f5eb..d991e21e747 100644 --- a/docs/sliderios.html +++ b/docs/sliderios.html @@ -1,4 +1,4 @@ -SliderIOS – React Native | A framework for building native apps using React

SliderIOS

Edit on GitHubProps #

disabled bool #

If true the user won't be able to move the slider. +SliderIOS – React Native | A framework for building native apps using React

SliderIOS

Edit on GitHubProps #

disabled bool #

If true the user won't be able to move the slider. Default value is false.

maximumTrackTintColor string #

The color used for the track to the right of the button. Overrides the default blue gradient image.

maximumValue number #

Initial maximum value of the slider. Default value is 1.

minimumTrackTintColor string #

The color used for the track to the left of the button. Overrides the default blue gradient image.

minimumValue number #

Initial minimum value of the slider. Default value is 0.

onSlidingComplete function #

Callback called when the user finishes changing the value (e.g. when diff --git a/docs/switchios.html b/docs/switchios.html index be26226f70b..1f419fbb4ea 100644 --- a/docs/switchios.html +++ b/docs/switchios.html @@ -2,7 +2,7 @@ a controlled component, so you must hook in to the onValueChange callback and update the value prop in order for the component to update, otherwise the user's change will be reverted immediately to reflect props.value as the -source of truth.

Edit on GitHubProps #

disabled bool #

If true the user won't be able to toggle the switch. +source of truth.

Edit on GitHubProps #

disabled bool #

If true the user won't be able to toggle the switch. Default value is false.

onTintColor string #

Background color when the switch is turned on.

onValueChange function #

Callback that is called when the user toggles the switch.

thumbTintColor string #

Background color for the switch round button.

tintColor string #

Background color when the switch is turned off.

value bool #

The value of the switch, if true the switch will be turned on. Default value is false.

Edit on GitHubExamples #

'use strict'; diff --git a/docs/tabbarios-item.html b/docs/tabbarios-item.html index 4c02168348f..b64a8bb9302 100644 --- a/docs/tabbarios-item.html +++ b/docs/tabbarios-item.html @@ -1,4 +1,4 @@ -TabBarIOS.Item – React Native | A framework for building native apps using React

TabBarIOS.Item

Edit on GitHubProps #

badge string, number #

Little red bubble that sits at the top right of the icon.

icon Image.propTypes.source #

A custom icon for the tab. It is ignored when a system icon is defined.

onPress function #

Callback when this tab is being selected, you should change the state of your +TabBarIOS.Item – React Native | A framework for building native apps using React

TabBarIOS.Item

Edit on GitHubProps #

badge string, number #

Little red bubble that sits at the top right of the icon.

icon Image.propTypes.source #

A custom icon for the tab. It is ignored when a system icon is defined.

onPress function #

Callback when this tab is being selected, you should change the state of your component to set selected={true}.

selected bool #

It specifies whether the children are visible or not. If you see a blank content, you probably forgot to add a selected one.

selectedIcon Image.propTypes.source #

A custom icon when the tab is selected. It is ignored when a system icon is defined. If left empty, the icon will be tinted in blue.

style View#style #

React style object.

systemIcon enum('bookmarks', 'contacts', 'downloads', 'favorites', 'featured', 'history', 'more', 'most-recent', 'most-viewed', 'recents', 'search', 'top-rated') #

Items comes with a few predefined system icons. Note that if you are diff --git a/docs/tabbarios.html b/docs/tabbarios.html index d8b6a46196d..a5dff0d4512 100644 --- a/docs/tabbarios.html +++ b/docs/tabbarios.html @@ -1,4 +1,4 @@ -TabBarIOS – React Native | A framework for building native apps using React

TabBarIOS

Edit on GitHubProps #

barTintColor string #

Background color of the tab bar

tintColor string #

Color of the currently selected tab icon

translucent bool #

A Boolean value that indicates whether the tab bar is translucent

Edit on GitHubExamples #

'use strict'; +TabBarIOS – React Native | A framework for building native apps using React

TabBarIOS

Edit on GitHubProps #

barTintColor string #

Background color of the tab bar

tintColor string #

Color of the currently selected tab icon

translucent bool #

A Boolean value that indicates whether the tab bar is translucent

Edit on GitHubExamples #

'use strict'; var React = require('react-native'); var { diff --git a/docs/webview.html b/docs/webview.html index dafe1e2831d..b779393f5c2 100644 --- a/docs/webview.html +++ b/docs/webview.html @@ -1,5 +1,5 @@ WebView – React Native | A framework for building native apps using React

WebView

Renders a native WebView.

Note that WebView is only supported on iOS for now, -see https://facebook.github.io/react-native/docs/known-issues.html

Edit on GitHubProps #

automaticallyAdjustContentInsets bool #

bounces bool #

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

html string #

injectedJavaScript string #

Sets the JS to be injected when the webpage loads.

javaScriptEnabledAndroid bool #

Used for android only, JS is enabled by default for WebView on iOS

onNavigationStateChange function #

onShouldStartLoadWithRequest function #

Allows custom handling of any webview requests by a JS handler. Return true +see https://facebook.github.io/react-native/docs/known-issues.html

Edit on GitHubProps #

automaticallyAdjustContentInsets bool #

bounces bool #

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

html string #

injectedJavaScript string #

Sets the JS to be injected when the webpage loads.

javaScriptEnabledAndroid bool #

Used for android only, JS is enabled by default for WebView on iOS

onNavigationStateChange function #

onShouldStartLoadWithRequest function #

Allows custom handling of any webview requests by a JS handler. Return true or false from this method to continue loading the request.

renderError function #

renderLoading function #

scalesPageToFit bool #

Used for iOS only, sets whether the webpage scales to fit the view and the user can change the scale

scrollEnabled bool #

startInLoadingState bool #

url string #

Edit on GitHubExamples #

'use strict';