Interface ScrollViewPropsAndroid

interface ScrollViewPropsAndroid {
    endFillColor?: ColorValue;
    fadingEdgeLength?: number;
    nestedScrollEnabled?: boolean;
    overScrollMode?: "auto" | "always" | "never";
    persistentScrollbar?: boolean;
    scrollPerfTag?: string;
}

Hierarchy (view full)

Properties

endFillColor? fadingEdgeLength? nestedScrollEnabled? overScrollMode? persistentScrollbar? scrollPerfTag?

Properties

Optional endFillColor

endFillColor?: ColorValue

Sometimes a scrollview takes up more space than its content fills. When this is the case, this prop will fill the rest of the scrollview with a color to avoid setting a background and creating unnecessary overdraw. This is an advanced optimization that is not needed in the general case.

Optional fadingEdgeLength

fadingEdgeLength?: number

Fades out the edges of the scroll content.

If the value is greater than 0, the fading edges will be set accordingly to the current scroll direction and position, indicating if there is more content to show.

The default value is 0.

Platform

android

Optional nestedScrollEnabled

nestedScrollEnabled?: boolean

Enables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.

Optional overScrollMode

overScrollMode?: "auto" | "always" | "never"

Used to override default value of overScroll mode.

  • Possible values:
    • 'auto' - Default value, allow a user to over-scroll this view only if the content is large enough to meaningfully scroll.
    • 'always' - Always allow a user to over-scroll this view.
    • 'never' - Never allow a user to over-scroll this view.

Optional persistentScrollbar

persistentScrollbar?: boolean

Causes the scrollbars not to turn transparent when they are not in use. The default value is false.

Optional scrollPerfTag

scrollPerfTag?: string

Tag used to log scroll performance on this scroll view. Will force momentum events to be turned on (see sendMomentumEvents). This doesn't do anything out of the box and you need to implement a custom native FpsListener for it to be useful.

Platform

android

On This Page