@groftware/lottie-flatlist
v1.0.6
Published
A Flatlist component that supports using custom lottie animations for pull to refresh
Downloads
7
Readme
To those interested in learning how this component is built, you can check out this article on Medium. We write articles explaining how our components are built on our Medium page. If you're interested in that, feel free to follow us.
LottieFlatlist
Table of contents
A Flatlist component allows you to turn any lottie animation into a pull to refresh component.
Installation
npm i @groftware/lottie-flatlist
or
yarn add @groftware/lottie-flatlist
Usage
Usage is similar to a regular FlatList, but with additional props. LottieFlatlist
accepts an animationSource
prop, which is any JSON Lottie animation.
Basic usage
import LottieFlatlist from '@groftware/lottie-flatlist'
export default function MyApp() {
const animationSource = require('./path/to/animation.json');
const data = [
'a',
'b',
'c',
'd',
'e',
'f',
'g',
'h',
];
const [refreshing, setRefreshing] = useState(false);
function onRefresh() {
setRefreshing(true);
setTimeout(() => {
setRefreshing(false);
}, 1000);
}
function renderItem({ item }) {
return (
<View key={item} style={styles.row}>
<Text style={styles.rowTitle}>{item}</Text>
</View>
);
}
return (
<View>
<LottieFlatlist
data={data}
renderItem={renderItem}
animationSource={animationSource}
refreshing={refreshing}
onRefresh={onRefresh}
/>
<View>
);
}
Advanced usage
<LottieFlatlist
data={fruits}
renderItem={renderItem}
animationSource={animationSource}
refreshing={refreshing}
onRefresh={onRefresh}
// Optional props
animationSize={30}
refreshHeight={100}
/>