1.0.0 • Published 3 years ago

rn-faded-flatlist v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

rn-faded-scrollview

A simple and customisable React Native component that allows you to add fade effect in FlatList at both ends. Based on rn-faded-scrollview.

Vertical ScrollHorizontal Scroll
npm.ionpm.io

Installation

This library relies on react-native-linear-gradient. Follow setup instructions of linear gradient.

And now finally run in your project directory.

npm install rn-faded-flatlist

OR

yarn add rn-faded-flatlist

Documentation

This library accepts all the props of FlatList and some additional props.

Props

NameDescriptionDefaultType
allowStartFadeAdd fade at the start of ScrollViewfalseBoolean
allowEndFadeAdd fade at the end of ScrollViewtrueBoolean
fadeSizeFade size i.e( width incase of horizontal and height incase of vertical ScrollView)20Number
fadeColorsColors for fade effect'rgba(229, 229, 229, 0.18)', 'rgba(206, 201, 201, 0.6)', 'rgba(206, 201, 201, 0.9)'Array
scrollThresholdThreshold to control fade hide/show when it reaches start or end10Number
allowDividerAllow divider at fade end.falseBoolean.
isRtlFor RTL LayoutsfalseBoolean.

Styling

For styling pass these props.

containerStyle, startFadeStyle, endFadeStyle and dividerStyle.

Events

NameCallback paramDescription
isCloseToEndBooleanif scroll is close to end or not.
isCloseToStartBooleanif scroll is close to start or not.