diff --git a/docs/image.html b/docs/image.html index 27604b724d0..c1d6741231d 100644 --- a/docs/image.html +++ b/docs/image.html @@ -15,7 +15,7 @@ images from local disk, such as the camera roll.

Example usage:

); },

Edit on GitHubProps #

onLayout function #

Invoked on mount and layout changes with {nativeEvent: {layout: {x, y, width, height}}}.

resizeMode enum('cover', 'contain', 'stretch') #

Determines how to resize the image when the frame doesn't match the raw -image dimensions.

source {uri: string} #

uri is a string representing the resource identifier for the image, which +image dimensions.

source {uri: string}, number #

uri is a string representing the resource identifier for the image, which could be an http address, a local file path, or the name of a static image resource (which should be wrapped in the require('image!name') function).

style style #

resizeMode Object.keys(ImageResizeMode)
backgroundColor string
borderColor string
borderWidth number
borderRadius number
overflow enum('visible', 'hidden')
tintColor string
opacity number

testID string #

A unique identifier for this element to be used in UI Automation testing scripts.

iosaccessibilityLabel string #

The text that's read by the screen reader when the user interacts with @@ -371,7 +371,7 @@ exports.examples ]; var fullImage = {uri: 'http://facebook.github.io/react/img/logo_og.png'}; -var smallImage = {uri: 'http://facebook.github.io/react/img/logo_small.png'}; +var smallImage = {uri: 'http://facebook.github.io/react/img/logo_small_2x.png'}; var styles = StyleSheet.create({ base: { diff --git a/docs/scrollview.html b/docs/scrollview.html index 5c607663f3a..16f7cb85681 100644 --- a/docs/scrollview.html +++ b/docs/scrollview.html @@ -20,9 +20,12 @@ wraps all of the child views. Example:

return ( instead of vertically in a column. The default value is false.

keyboardDismissMode enum("none", 'interactive', 'on-drag') #

Determines whether the keyboard gets dismissed in response to a drag. - 'none' (the default), drags do not dismiss the keyboard. - 'on-drag', the keyboard is dismissed when a drag begins. - - 'interactive', the keyboard is dismissed interactively with the drag - and moves in synchrony with the touch; dragging upwards cancels the - dismissal.

onScroll function #

Fires at most once per frame during scrolling. The frequency of the + - 'interactive', the keyboard is dismissed interactively with the drag and moves in + synchrony with the touch; dragging upwards cancels the dismissal. + On android this is not supported and it will have the same behavior as 'none'.

keyboardShouldPersistTaps bool #

When false, tapping outside of the focused text input when the keyboard +is up dismisses the keyboard. When true, the scroll view will not catch +taps, and the keyboard will not dismiss automatically. The default value +is false.

onScroll function #

Fires at most once per frame during scrolling. The frequency of the events can be contolled using the scrollEventThrottle prop.

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 @@ -47,10 +50,7 @@ The default value is {x: 0, y: 0}.

iosdirectionalLockEnabled bool #

When true, the ScrollView will try to lock to only vertical or horizontal -scrolling while dragging. The default value is false.

ioskeyboardShouldPersistTaps bool #

When false, tapping outside of the focused text input when the keyboard -is up dismisses the keyboard. When true, the scroll view will not catch -taps, and the keyboard will not dismiss automatically. The default value -is false.

iosmaximumZoomScale number #

The maximum allowed zoom scale. The default value is 1.0.

iosminimumZoomScale number #

The minimum allowed zoom scale. The default value is 1.0.

iosonScrollAnimationEnd function #

Called when a scrolling animation ends.

iospagingEnabled bool #

When true, the scroll view stops on multiples of the scroll view's size +scrolling while dragging. The default value is false.

iosmaximumZoomScale number #

The maximum allowed zoom scale. The default value is 1.0.

iosminimumZoomScale number #

The minimum allowed zoom scale. The default value is 1.0.

iosonScrollAnimationEnd function #

Called when a scrolling animation ends.

iospagingEnabled bool #

When true, the scroll view stops on multiples of the scroll view's size when scrolling. This can be used for horizontal pagination. The default value is false.

iosscrollEnabled bool #

When false, the content does not scroll. The default value is true.

iosscrollEventThrottle number #

This controls how often the scroll event will be fired while scrolling diff --git a/docs/tabbarios.html b/docs/tabbarios.html index c2bcd3f4d98..b27f1d212c8 100644 --- a/docs/tabbarios.html +++ b/docs/tabbarios.html @@ -8,6 +8,8 @@ View, } = React; +var base64Icon = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEsAAABLCAQAAACSR7JhAAADtUlEQVR4Ac3YA2Bj6QLH0XPT1Fzbtm29tW3btm3bfLZtv7e2ObZnms7d8Uw098tuetPzrxv8wiISrtVudrG2JXQZ4VOv+qUfmqCGGl1mqLhoA52oZlb0mrjsnhKpgeUNEs91Z0pd1kvihA3ULGVHiQO2narKSHKkEMulm9VgUyE60s1aWoMQUbpZOWE+kaqs4eLEjdIlZTcFZB0ndc1+lhB1lZrIuk5P2aib1NBpZaL+JaOGIt0ls47SKzLC7CqrlGF6RZ09HGoNy1lYl2aRSWL5GuzqWU1KafRdoRp0iOQEiDzgZPnG6DbldcomadViflnl/cL93tOoVbsOLVM2jylvdWjXolWX1hmfZbGR/wjypDjFLSZIRov09BgYmtUqPQPlQrPapecLgTIy0jMgPKtTeob2zWtrGH3xvjUkPCtNg/tm1rjwrMa+mdUkPd3hWbH0jArPGiU9ufCsNNWFZ40wpwn+62/66R2RUtoso1OB34tnLOcy7YB1fUdc9e0q3yru8PGM773vXsuZ5YIZX+5xmHwHGVvlrGPN6ZSiP1smOsMMde40wKv2VmwPPVXNut4sVpUreZiLBHi0qln/VQeI/LTMYXpsJtFiclUN+5HVZazim+Ky+7sAvxWnvjXrJFneVtLWLyPJu9K3cXLWeOlbMTlrIelbMDlrLenrjEQOtIF+fuI9xRp9ZBFp6+b6WT8RrxEpdK64BuvHgDk+vUy+b5hYk6zfyfs051gRoNO1usU12WWRWL73/MMEy9pMi9qIrR4ZpV16Rrvduxazmy1FSvuFXRkqTnE7m2kdb5U8xGjLw/spRr1uTov4uOgQE+0N/DvFrG/Jt7i/FzwxbA9kDanhf2w+t4V97G8lrT7wc08aA2QNUkuTfW/KimT01wdlfK4yEw030VfT0RtZbzjeMprNq8m8tnSTASrTLti64oBNdpmMQm0eEwvfPwRbUBywG5TzjPCsdwk3IeAXjQblLCoXnDVeoAz6SfJNk5TTzytCNZk/POtTSV40NwOFWzw86wNJRpubpXsn60NJFlHeqlYRbslqZm2jnEZ3qcSKgm0kTli3zZVS7y/iivZTweYXJ26Y+RTbV1zh3hYkgyFGSTKPfRVbRqWWVReaxYeSLarYv1Qqsmh1s95S7G+eEWK0f3jYKTbV6bOwepjfhtafsvUsqrQvrGC8YhmnO9cSCk3yuY984F1vesdHYhWJ5FvASlacshUsajFt2mUM9pqzvKGcyNJW0arTKN1GGGzQlH0tXwLDgQTurS8eIQAAAABJRU5ErkJggg=='; + var TabBarExample = React.createClass({ statics: { title: '<TabBarIOS>', @@ -40,6 +42,7 @@ barTintColor="darkslateblue"> <TabBarIOS.Item title="Blue Tab" + icon={{uri: base64Icon, scale: 3}} selected={this.state.selectedTab === 'blueTab'} onPress={() => { this.setState({ diff --git a/docs/textinput.html b/docs/textinput.html index 6c9128fced5..4354279cd3e 100644 --- a/docs/textinput.html +++ b/docs/textinput.html @@ -33,7 +33,7 @@ either set editable={false}, or set/update maxLength t unwanted edits without flicker.

iosclearButtonMode enum('never', 'while-editing', 'unless-editing', 'always') #

When the clear button should appear on the right side of the text view

iosclearTextOnFocus bool #

If true, clears the text field automatically when editing begins

iosenablesReturnKeyAutomatically bool #

If true, the keyboard disables the return key when there is no text and automatically enables it when there is text. The default value is false.

iosmaxLength number #

Limits the maximum number of characters that can be entered. Use this instead of implementing the logic in JS to avoid flicker.

iosreturnKeyType enum('default', 'go', 'google', 'join', 'next', 'route', 'search', 'send', 'yahoo', 'done', 'emergency-call') #

Determines how the return key should look.

iosselectTextOnFocus bool #

If true, all text will automatically be selected on focus

iosselectionState DocumentSelectionState #

See DocumentSelectionState.js, some state that is responsible for -maintaining selection information for a document

androidtextAlignVertical enum('top', 'center', 'bottom') #

Aligns text vertically within the TextInput.

androidunderlineColorAndroid string #

The color of the textInput underline.

Edit on GitHubExamples #

'use strict'; +maintaining selection information for a document

androidtextAlignVertical enum('top', 'center', 'bottom') #

Aligns text vertically within the TextInput.

androidunderlineColorAndroid string #

The color of the textInput underline.

Edit on GitHubExamples #

'use strict'; var React = require('react-native'); var { diff --git a/docs/view.html b/docs/view.html index 03100bbb8cf..9b410d24e77 100644 --- a/docs/view.html +++ b/docs/view.html @@ -9,14 +9,9 @@ wraps two colored boxes and custom component in a row with padding.

={{backgroundColor: 'red', flex: 0.5}} /> <MyCustomComponent {...customProps} /> </View>

Views are designed to be used with StyleSheets for clarity and -performance, although inline styles are also supported.

Edit on GitHubProps #

accessibilityComponentType enum('none', 'button') #

Indicates to accessibility services to treat UI component like a -native one. Works for Android only.

accessibilityLabel string #

Overrides the text that's read by the screen reader when the user interacts +performance, although inline styles are also supported.

Edit on GitHubProps #

accessibilityLabel string #

Overrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the -children and accumulating all the Text nodes separated by space.

accessibilityLiveRegion enum('none', 'polite', 'assertive') #

Indicates to accessibility services whether the user should be notified -when this view changes. Works for Android API >= 19 only. -See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion -for references.

accessibilityTraits AccessibilityTraits, [AccessibilityTraits] #

Provides additional traits to screen reader. By default no traits are -provided unless specified otherwise in element

accessible bool #

When true, indicates that the view is an accessibility element. By default, +children and accumulating all the Text nodes separated by space.

accessible bool #

When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.

onAcccessibilityTap function #

When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.

onLayout function #

Invoked on mount and layout changes with

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

onMagicTap function #

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

onMoveShouldSetResponder function #

For most touch interactions, you'll simply want to wrap your component in @@ -42,7 +37,23 @@ 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).

style style #

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')
opacity number
overflow enum('visible', 'hidden')
shadowColor string
shadowOffset {width: number, height: number}
shadowOpacity number
shadowRadius number

testID string #

Used to locate this view in end-to-end tests. NB: disables the 'layout-only -view removal' optimization for this view!

androidcollapsable bool #

androidrenderToHardwareTextureAndroid bool #

Whether this view should render itself (and all of its children) into a +view removal' optimization for this view!

androidaccessibilityComponentType enum('none', 'button', 'radiobutton_checked', 'radiobutton_unchecked') #

Indicates to accessibility services to treat UI component like a +native one. Works for Android only.

androidaccessibilityLiveRegion enum('none', 'polite', 'assertive') #

Indicates to accessibility services whether the user should be notified +when this view changes. Works for Android API >= 19 only. +See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion +for references.

iosaccessibilityTraits AccessibilityTraits, [AccessibilityTraits] #

Provides additional traits to screen reader. By default no traits are +provided unless specified otherwise in element

androidcollapsable bool #

androidimportantForAccessibility enum('auto', 'yes', 'no', 'no-hide-descendants') #

Controls how view is important for accessibility which is if it +fires accessibility events and if it is reported to accessibility services +that query the screen. Works for Android only. +See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility +for references. +Possible values: +'auto' - The system determines whether the view is important for accessibility - + default (recommended). +'yes' - The view is important for accessibility. +'no' - The view is not important for accessibility. +'no-hide-descendants' - The view is not important for accessibility, + nor are any of its descendant views.

androidrenderToHardwareTextureAndroid bool #

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