# react-native-flatlist-header

> Flatlist with a header animated show image and icons

Latest version **1.0.1** (published 2020-05-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install react-native-flatlist-header
pnpm add react-native-flatlist-header
yarn add react-native-flatlist-header
bun add react-native-flatlist-header
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-05-11 |
| First published | 2020-05-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | alvesdiego18 |

## Links

- npm: https://www.npmjs.com/package/react-native-flatlist-header
- Repository: https://github.com/alvesdiego18/react-native-flatlist-header
- Homepage: https://github.com/alvesdiego18/react-native-flatlist-header#readme
- Issues: https://github.com/alvesdiego18/react-native-flatlist-header/issues
- npm.io page: https://npm.io/package/react-native-flatlist-header

## Recent versions

- 1.0.1 (latest) — 2020-05-11
- 1.0.0 — 2020-05-11

## README

# react-native-flatlist-header

![SliderBox](assets/demo.gif)

## Custom FlatlistHeader
> Component based 100% on React-Native's own Flatlist

| Props | Value Type | Description | Default |
|--|--|--|--|
| navBar | Number | Size the Nav bar should be when scrolling up | 79 |
| height | Number | Size at which the component must occupy when scrolling down  | 150 |
| image | Image path to be used | require if image local or {uri: url} from image web | null |
| imageSize | Sets value for image size with end navBar | Number | 35 |
| marginImage | Number | fine adjustments to the image left when scrolling up | 280 |
| rightItem | Component RN | If you want to insert a component in the right corner | null |
| color | Color Hexadecimal | Component background color | #333 |

## Install
> npm i react-native-flatlist-header

## Usage :
### 1- add below import in your code :
```js
import { FlatlistHeader } from "react-native-flatlist-header";
```
### 2- Define the props according to the documentation above or copy the example below.

```js
<FlatlistHeader
   data={data}
   renderItem={({item}) => <Item item={item} />}
   keyExtractor={item  =>  item.id}
   
   rightItem={<Icon type='Feather' name='bell' />}
   image={require('./src/assets/logo.png')}
   navBar={80}
   height={150}
   color={'#d13636'}
   marginImage={270}
/>
```

---
_Source: https://npm.io/package/react-native-flatlist-header · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._