From 13c02ed338f2bef47e844d79c3b5c5a09be3e292 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Wed, 24 May 2017 13:04:58 +0000 Subject: [PATCH] Updated docs for next --- releases/next/docs/scrollview.html | 49 ++++++++++++------------------ 1 file changed, 19 insertions(+), 30 deletions(-) diff --git a/releases/next/docs/scrollview.html b/releases/next/docs/scrollview.html index f76daaa805b..428f590ca11 100644 --- a/releases/next/docs/scrollview.html +++ b/releases/next/docs/scrollview.html @@ -16,29 +16,26 @@ just 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 #

ViewPropTypes props... #

contentContainerStyle?: StyleSheetPropType(ViewStylePropTypes) #

These styles will be applied to the scroll view content container which -wraps all of the child views. Example:

return ( - <ScrollView contentContainerStyle={styles.contentContainer}> - </ScrollView> - ); - ... - const styles = StyleSheet.create({ - contentContainer: { - paddingVertical: 20 - } - });

horizontal?: PropTypes.bool #

When true, the scroll view's children are arranged horizontally in a row +wraps all of the child views. Example:

return ( + <ScrollView contentContainerStyle={styles.contentContainer}> + </ScrollView> +); +... +const styles = StyleSheet.create({ + contentContainer: { + paddingVertical: 20 + } +});

horizontal?: PropTypes.bool #

When true, the scroll view's children are arranged horizontally in a row instead of vertically in a column. The default value is false.

keyboardDismissMode?: PropTypes.oneOf([ 'none', // default '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. - On android this is not supported and it will have the same behavior as 'none'.

keyboardShouldPersistTaps?: PropTypes.oneOf(['always', 'never', 'handled', false, true]) #

Determines when the keyboard should stay visible after a tap.

  • 'never' (the default), tapping outside of the focused text input when the keyboard -is up dismisses the keyboard. When this happens, children won't receive the tap.
  • 'always', the keyboard will not dismiss automatically, and the scroll view will not -catch taps, but children of the scroll view can catch taps.
  • 'handled', the keyboard will not dismiss automatically when the tap was handled by -a children, (or captured by an ancestor).
  • false, deprecated, use 'never' instead
  • true, deprecated, use 'always' instead

onContentSizeChange?: PropTypes.func #

Called when scrollable content view of the ScrollView changes.

Handler function is passed the content width and content height as parameters: +]) #

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. +On android this is not supported and it will have the same behavior as 'none'.

keyboardShouldPersistTaps?: PropTypes.oneOf(['always', 'never', 'handled', false, true]) #

Determines when the keyboard should stay visible after a tap.

  • 'never' (the default), tapping outside of the focused text input when the keyboard +is up dismisses the keyboard. When this happens, children won't receive the tap.
  • 'always', the keyboard will not dismiss automatically, and the scroll view will not +catch taps, but children of the scroll view can catch taps.
  • 'handled', the keyboard will not dismiss automatically when the tap was handled by +a children, (or captured by an ancestor).
  • false, deprecated, use 'never' instead
  • true, deprecated, use 'always' instead

onContentSizeChange?: PropTypes.func #

Called when scrollable content view of the ScrollView changes.

Handler function is passed the content width and content height as parameters: (contentWidth, contentHeight)

It's implemented using onLayout handler attached to the content container which this ScrollView renders.

onScroll?: PropTypes.func #

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

pagingEnabled?: PropTypes.bool #

When true, the scroll view stops on multiples of the scroll view's size @@ -93,17 +90,12 @@ The default value is {x: 0, y: 0}.

"normal" and "fast" which match the underlying iOS settings for UIScrollViewDecelerationRateNormal and -UIScrollViewDecelerationRateFast respectively. - - normal: 0.998 (the default) - - fast: 0.99

iosdirectionalLockEnabled?: PropTypes.bool #

When true, the ScrollView will try to lock to only vertical or horizontal +UIScrollViewDecelerationRateFast respectively.

  • 'normal': 0.998 (the default)
  • 'fast': 0.99

iosdirectionalLockEnabled?: PropTypes.bool #

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

iosindicatorStyle?: PropTypes.oneOf([ 'default', // default 'black', 'white', -]) #

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.

iosmaximumZoomScale?: PropTypes.number #

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

iosminimumZoomScale?: PropTypes.number #

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

iosonScrollAnimationEnd?: PropTypes.func #

Called when a scrolling animation ends.

iosscrollEventThrottle?: PropTypes.number #

This controls how often the scroll event will be fired while scrolling +]) #

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.

iosmaximumZoomScale?: PropTypes.number #

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

iosminimumZoomScale?: PropTypes.number #

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

iosonScrollAnimationEnd?: PropTypes.func #

Called when a scrolling animation ends.

iosscrollEventThrottle?: PropTypes.number #

This controls how often the scroll event will be fired while scrolling (as a time interval in ms). A lower number yields better accuracy for code that is tracking the scroll position, but can lead to scroll performance problems due to the volume of information being send over the bridge. @@ -119,10 +111,7 @@ The default value is true.

#

When snapToInterval is set, snapToAlignment will define the relationship -of the snapping to the scroll view. - - start (the default) will align the snap at the left (horizontal) or top (vertical) - - center will align the snap in the center - - end will align the snap at the right (horizontal) or bottom (vertical)

iossnapToInterval?: PropTypes.number #

When set, causes the scroll view to stop at multiples of the value of +of the snapping to the scroll view.

  • 'start' (the default) will align the snap at the left (horizontal) or top (vertical)
  • 'center' will align the snap in the center
  • 'end' will align the snap at the right (horizontal) or bottom (vertical)

iossnapToInterval?: PropTypes.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.

ioszoomScale?: PropTypes.number #

The current scale of the scroll view content. The default value is 1.0.

Methods #

scrollTo(y?: number, object, x?: number, animated?: boolean) #

Scrolls to a given x, y offset, either immediately or with a smooth animation.

Example:

scrollTo({x: 0, y: 0, animated: true})

Note: The weird function signature is due to the fact that, for historical reasons,