# derp-list

> A React library for rendering a list of data like Google Chrome on mobile devices.

Latest version **1.0.3** (published 2018-11-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install derp-list
pnpm add derp-list
yarn add derp-list
bun add derp-list
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2018-11-24 |
| First published | 2018-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 692.7 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Author | Shooting Unicorns |
| Maintainers | shooting-unicorns |
| Keywords | react-component, react-library, react-list, derp-list |

## Links

- npm: https://www.npmjs.com/package/derp-list
- Repository: https://github.com/shooting-unicorns/derp-list
- Homepage: https://shooting-unicorns.com
- Issues: https://github.com/shooting-unicorns/derp-list/issues
- npm.io page: https://npm.io/package/derp-list

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [react-loads](https://npm.io/package/react-loads.md) 6.0.1
- [react-test-renderer](https://npm.io/package/react-test-renderer.md) ^16.6.3

## Recent versions

- 1.0.3 (latest) — 2018-11-24
- 1.0.2 — 2018-11-24
- 1.0.1 — 2018-09-21
- 1.0.0 — 2018-09-21

## README

# derp-list 🤓🦄

A React library for rendering a list of data like Google search results.

![alt text](https://shooting-unicorns.com/images/derp-list-demo.gif "Derp list demo")

## Installation

```
npm install derp-list --save
```

or install with [Yarn](https://yarnpkg.com) if you prefer:

```
yarn add derp-list
```

## Usage


```js

getRandomPosts = async ({ page }: { page: number } = {}) => {
    const query = { page: page || 1 };
    const randomPosts = await getExamplePosts(query);

    return { items: randomPosts.data, pageCount: randomPosts.total_pages };
};

```

```js
export default () => (
   <Fragment>
        <h1>
          Derp list demo
          <br />
          <a href="https://shooting-unicorns.com">
            A Google like data list!
            <span role="img" aria-label="shooting unicorns">
              🦄
            </span>
          </a>
        </h1>
        <DerpList
          contextKey="items"
          dataRenderer={({ isLoading, items }) => (
            <Fragment>
              {isLoading && items.length === 0 && <div>loading</div>}
              {items.map((item, index) => (
                /* eslint-disable react/no-array-index-key */
                <div key={index}>{item.name}</div>
              ))}
            </Fragment>
          )}
          emptyRenderer={() => <div>No items...</div>}
          errorRenderer={({ error }) => <div>The following error has occured: {error}</div>}
          loadData={this.getRandomPosts}
          loadMoreRenderer={({ isLoading, loadMore }) => (
            <Fragment>
              {isLoading && <div>loading...</div>}
              <button onClick={loadMore}>More results</button>
            </Fragment>
          )}
        />
      </Fragment>
);
```

### contextKey

> `string`

DerpList uses ReactLoads which offers an unique identifier for caching responses. If the `contextKey` changes, then data will be fetched again.


### `children` Render Props
#### loadMoreRenderer

> `any`

Returns `isLoading` when data is fetching and `loadMore` function to fetch more data from your paginated request.

#### dataRenderer

> `any`

Returns `isLoading` when data is fetching and `items` when a response is received.

#### emptyRenderer

> `any`

Renders when no data is fetched.

#### errorRenderer

> `any`

Renders when an error has occured.






[build-badge]: https://img.shields.io/travis/user/repo/master.png?style=flat-square
[build]: https://travis-ci.org/user/repo

[npm-badge]: https://img.shields.io/npm/v/npm-package.png?style=flat-square
[npm]: https://www.npmjs.org/package/npm-package

[coveralls-badge]: https://img.shields.io/coveralls/user/repo/master.png?style=flat-square
[coveralls]: https://coveralls.io/github/user/repo

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