From dcf03a6d48a943456b8b18cafbc7f200e854f17f Mon Sep 17 00:00:00 2001 From: Travis CI Date: Wed, 23 Dec 2015 18:30:12 +0000 Subject: [PATCH] update website --- docs/dimensions.html | 2 +- docs/image.html | 2 +- docs/listview.html | 30 +++++++++++++++--------------- docs/mapview.html | 4 ++-- docs/progressbarandroid.html | 2 +- docs/pulltorefreshviewandroid.html | 2 +- docs/scrollview.html | 2 +- docs/switchios.html | 2 +- docs/tabbarios.html | 2 +- docs/text.html | 2 +- docs/toolbarandroid.html | 16 +++++++++++----- docs/touchablehighlight.html | 2 +- docs/view.html | 12 +----------- 13 files changed, 38 insertions(+), 42 deletions(-) diff --git a/docs/dimensions.html b/docs/dimensions.html index 3685441033d..8bd8a8056c8 100644 --- a/docs/dimensions.html +++ b/docs/dimensions.html @@ -3,7 +3,7 @@ be available before any other require's are run, but may be updated later.< due to device rotation) so any rendering logic or styles that depend on these constants should try to call this function on every render, rather than caching the value (for example, using inline styles rather than -setting a value in a StyleSheet).

@param {string} dim Name of dimension as defined when calling set. +setting a value in a StyleSheet).

Example: var {height, width} = Dimensions.get('window');

@param {string} dim Name of dimension as defined when calling set. @returns {Object?} Value for the dimension.

Next →
React Native

Quick Start

Guides

Guides (iOS)

Guides (Android)

components

apis

Polyfills

PullToRefreshViewAndroid

React view that supports a single scrollable child view (e.g. ScrollView). When this child view is at scrollY: 0, swiping down triggers an onRefresh event.

The style {flex: 1} might be required to ensure the expected behavior of the child component -(e.g. when the child is expected to scroll with ScrollView or ListView).

Edit on GitHubProps #

View props... #

colors [string] #

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

enabled bool #

Whether the pull to refresh functionality is enabled

progressBackgroundColor string #

The background color of the refresh indicator

refreshing bool #

Whether the view should be indicating an active refresh

size RefreshLayoutConsts.SIZE.DEFAULT #

Size of the refresh indicator, see PullToRefreshViewAndroid.SIZE

Edit on GitHubExamples #

'use strict'; +(e.g. when the child is expected to scroll with ScrollView or ListView).

Edit on GitHubProps #

View props... #

colors [ColorPropType] #

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

enabled bool #

Whether the pull to refresh functionality is enabled

progressBackgroundColor ColorPropType #

The background color of the refresh indicator

refreshing bool #

Whether the view should be indicating an active refresh

size RefreshLayoutConsts.SIZE.DEFAULT #

Size of the refresh indicator, see PullToRefreshViewAndroid.SIZE

Edit on GitHubExamples #

'use strict'; const React = require('react-native'); const { diff --git a/docs/scrollview.html b/docs/scrollview.html index a3ce984e78d..77a13b92dd7 100644 --- a/docs/scrollview.html +++ b/docs/scrollview.html @@ -31,7 +31,7 @@ which this ScrollView renders.

removeClippedSubviews bool #

Experimental: When true, offscreen child views (whose overflow value is hidden) are removed from their native backing superview when offscreen. This can improve scrolling performance on long lists. The default value is -true.

showsHorizontalScrollIndicator bool #

When true, shows a horizontal scroll indicator.

showsVerticalScrollIndicator bool #

When true, shows a vertical scroll indicator.

style style #

Flexbox...
Transforms...
backfaceVisibility enum('visible', 'hidden')
backgroundColor string
borderColor string
borderTopColor string
borderRightColor string
borderBottomColor string
borderLeftColor string
borderRadius number
borderTopLeftRadius number
borderTopRightRadius number
borderBottomLeftRadius number
borderBottomRightRadius number
borderStyle enum('solid', 'dotted', 'dashed')
borderWidth number
borderTopWidth number
borderRightWidth number
borderBottomWidth number
borderLeftWidth number
opacity number
overflow enum('visible', 'hidden')
shadowColor string
shadowOffset {width: number, height: number}
shadowOpacity number
shadowRadius number
elevation number

iosalwaysBounceHorizontal bool #

When true, the scroll view bounces horizontally when it reaches the end +true.

showsHorizontalScrollIndicator bool #

When true, shows a horizontal scroll indicator.

showsVerticalScrollIndicator bool #

When true, shows a vertical scroll indicator.

style style #

Flexbox...
Transforms...
backfaceVisibility enum('visible', 'hidden')
backgroundColor ColorPropType
borderColor ColorPropType
borderTopColor ColorPropType
borderRightColor ColorPropType
borderBottomColor ColorPropType
borderLeftColor ColorPropType
borderRadius number
borderTopLeftRadius number
borderTopRightRadius number
borderBottomLeftRadius number
borderBottomRightRadius number
borderStyle enum('solid', 'dotted', 'dashed')
borderWidth number
borderTopWidth number
borderRightWidth number
borderBottomWidth number
borderLeftWidth number
opacity number
overflow enum('visible', 'hidden')
shadowColor ColorPropType
shadowOffset {width: number, height: number}
shadowOpacity number
shadowRadius number
elevation number

iosalwaysBounceHorizontal bool #

When true, the scroll view bounces horizontally when it reaches the end even if the content is smaller than the scroll view itself. The default value is true when horizontal={true} and false otherwise.

iosalwaysBounceVertical bool #

When true, the scroll view bounces vertically when it reaches the end even if the content is smaller than the scroll view itself. The default diff --git a/docs/switchios.html b/docs/switchios.html index 87aa3dead49..77d4529e45b 100644 --- a/docs/switchios.html +++ b/docs/switchios.html @@ -3,7 +3,7 @@ a controlled component, so you must hook in to the onValueChange ca 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 #

View props... #

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.

onTintColor ColorPropType #

Background color when the switch is turned on.

onValueChange function #

Callback that is called when the user toggles the switch.

thumbTintColor ColorPropType #

Background color for the switch round button.

tintColor ColorPropType #

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'; var React = require('react-native'); diff --git a/docs/tabbarios.html b/docs/tabbarios.html index d67316d5416..10a4b5a8343 100644 --- a/docs/tabbarios.html +++ b/docs/tabbarios.html @@ -1,4 +1,4 @@ -TabBarIOS – React Native | A framework for building native apps using React
React Native

Quick Start

Guides

Guides (iOS)

Guides (Android)

components

apis

Polyfills

TabBarIOS

Edit on GitHubProps #

View props... #

barTintColor string #

Background color of the tab bar

style View#style #

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
React Native

Quick Start

Guides

Guides (iOS)

Guides (Android)

components

apis

Polyfills

TabBarIOS

Edit on GitHubProps #

View props... #

barTintColor ColorPropType #

Background color of the tab bar

style View#style #

tintColor ColorPropType #

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/text.html b/docs/text.html index b797150155c..645f85b7c6e 100644 --- a/docs/text.html +++ b/docs/text.html @@ -25,7 +25,7 @@ each other on account of the literal newlines:

}, };

Edit on GitHubProps #

accessible #

allowFontScaling bool #

Specifies should fonts scale to respect Text Size accessibility setting on iOS.

numberOfLines number #

Used to truncate the text with an ellipsis after computing the text layout, including line wrapping, such that the total number of lines -does not exceed this number.

onLayout function #

Invoked on mount and layout changes with

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

onPress function #

This function is called on press.

style style #

View#style...
color string
fontFamily string
fontSize number
fontStyle enum('normal', 'italic')
fontWeight enum("normal", 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900')
letterSpacing number
lineHeight number
textAlign enum("auto", 'left', 'right', 'center', 'justify')
textDecorationLine enum("none", 'underline', 'line-through', 'underline line-through')
textDecorationStyle enum("solid", 'double', 'dotted', 'dashed')
textDecorationColor string
writingDirection enum("auto", 'ltr', 'rtl')

testID string #

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

iossuppressHighlighting bool #

When true, no visual change is made when text is pressed down. By +does not exceed this number.

onLayout function #

Invoked on mount and layout changes with

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

onPress function #

This function is called on press.

style style #

View#style...
color ColorPropType
fontFamily string
fontSize number
fontStyle enum('normal', 'italic')
fontWeight enum("normal", 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900')
letterSpacing number
lineHeight number
textAlign enum("auto", 'left', 'right', 'center', 'justify')
textDecorationLine enum("none", 'underline', 'line-through', 'underline line-through')
textDecorationStyle enum("solid", 'double', 'dotted', 'dashed')
textDecorationColor ColorPropType
writingDirection enum("auto", 'ltr', 'rtl')

testID string #

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

iossuppressHighlighting bool #

When true, no visual change is made when text is pressed down. By default, a gray oval highlights the text on press down.

Edit on GitHubDescription #

Nested Text #

In iOS, the way to display formatted text is by using NSAttributedString: you give the text that you want to display and annotate ranges with some specific formatting. In practice, this is very tedious. For React Native, we decided to use web paradigm for this where you can nest text to achieve the same effect.

<Text style={{fontWeight: 'bold'}}> I am bold <Text style={{color: 'red'}}> diff --git a/docs/toolbarandroid.html b/docs/toolbarandroid.html index 8ef4d8ee4d3..3842d9440ae 100644 --- a/docs/toolbarandroid.html +++ b/docs/toolbarandroid.html @@ -8,9 +8,9 @@ URL. In release mode you should always use a drawable resource for these icons. explicitly use e.g. {uri: 'http://...'}, you will be good.

Example:

render: function() { return ( <ToolbarAndroid - logo={require('image!app_logo')} + logo={require('./app_logo.png')} title="AwesomeApp" - actions={[{title: 'Settings', icon: require('image!icon_settings'), show: 'always'}]} + actions={[{title: 'Settings', icon: require('./icon_settings.png'), show: 'always'}]} onActionSelected={this.onActionSelected} /> ) }, @@ -20,12 +20,18 @@ onActionSelected: } }

Edit on GitHubProps #

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('image!some_icon')
  • 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

logo optionalImageSource #

Sets the toolbar logo.

navIcon optionalImageSource #

Sets the navigation icon.

onActionSelected function #

Callback that is called when an action is selected. The only argument that is passed to the +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 +the navigation button and menu. Insets define the minimum margin for +these components and can be used to effectively align Toolbar content +along well-known gridlines.

contentInsetStart number #

Sets the content inset for the toolbar starting edge.

The content inset affects the valid area for Toolbar content other than +the navigation button and menu. Insets define the minimum margin for +these components and can be used to effectively align Toolbar content +along well-known gridlines.

logo optionalImageSource #

Sets the toolbar logo.

navIcon optionalImageSource #

Sets the navigation icon.

onActionSelected function #

Callback that is called when an action is selected. The only argument that is passed to the callback is the position of the action in the actions array.

onIconClicked function #

Callback called when the icon is selected.

overflowIcon optionalImageSource #

Sets the overflow icon.

rtl bool #

Used to set the toolbar direction to RTL. In addition to this property you need to add

android:supportsRtl="true"

to your application AndroidManifest.xml and then call setLayoutDirection(LayoutDirection.RTL) in your MainActivity -onCreate method.

subtitle string #

Sets the toolbar subtitle.

subtitleColor string #

Sets the toolbar subtitle color.

testID string #

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

title string #

Sets the toolbar title.

titleColor string #

Sets the toolbar title color.

Edit on GitHubExamples #

'use strict'; +onCreate method.

subtitle string #

Sets the toolbar subtitle.

subtitleColor ColorPropType #

Sets the toolbar subtitle color.

testID string #

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

title string #

Sets the toolbar title.

titleColor ColorPropType #

Sets the toolbar title color.

Edit on GitHubExamples #

'use strict'; var React = require('react-native'); var { diff --git a/docs/touchablehighlight.html b/docs/touchablehighlight.html index 0b04933094a..f8c0cda2d1c 100644 --- a/docs/touchablehighlight.html +++ b/docs/touchablehighlight.html @@ -13,7 +13,7 @@ backgroundColor of the wrapped view isn't explicitly set to an opaque color </TouchableHighlight> ); },

NOTE: TouchableHighlight supports only one child

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

Edit on GitHubProps #

TouchableWithoutFeedback props... #

activeOpacity number #

Determines what the opacity of the wrapped view should be when touch is -active.

onHideUnderlay function #

Called immediately after the underlay is hidden

onShowUnderlay function #

Called immediately after the underlay is shown

style View#style #

underlayColor string #

The color of the underlay that will show through when the touch is +active.

onHideUnderlay function #

Called immediately after the underlay is hidden

onShowUnderlay function #

Called immediately after the underlay is shown

style View#style #

underlayColor ColorPropType #

The color of the underlay that will show through when the touch is active.

Next →
© 2015 Facebook Inc.