# awesome-react-list

> A simple two lined list view with icon and action button

Latest version **0.0.2** (published 2017-05-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install awesome-react-list
pnpm add awesome-react-list
yarn add awesome-react-list
bun add awesome-react-list
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-05-22 |
| First published | 2017-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | marudhupandiyang@gmail.com |
| Maintainers | marudhupandiyang |
| Keywords | simple-list, listview, react-listview |

## Links

- npm: https://www.npmjs.com/package/awesome-react-list
- Repository: https://github.com/marudhupandiyang/simple-list
- Issues: https://github.com/marudhupandiyang/simple-list/issues
- npm.io page: https://npm.io/package/awesome-react-list

## Dependencies (1)

- [react](https://npm.io/package/react.md) ^15.5.4

## Recent versions

- 0.0.2 (latest) — 2017-05-22
- 0.0.1 — 2017-05-21

## README

# React Simple list view
 This is a simple implementation of a two lined list view in react. It has an icon and an action button in each row.
 This is a preliminary implementation. PR's are welcome.

 ![Simple List view](http://i.imgur.com/NVyJ4DK.png)


 # Installation

     npm install awesome-react-list

or if you are using `yarn`

    yarn add awesome-react-list


 # Usage

     import SimpleList from 'awesome-react-list'

     <SimpleList
          title={`Items Pending(${items.length})`}
          items={items}
          onItemClick={(item) => console.log(`Clicked item ${item.title}`)}
          itemActionClick={(item) => {console.log(`Action clicked for ${item.title}`)}}
        />


You items should be of the below format.

      // declare the items your require
      let items = [
        {
          id: 1,
          title: 'Verify your email address',
          subtitle: 'Verification email sent',
          icon: '/Email-Logo.png'
        },
        {
          id: 2,
          title: 'Complete your profile',
          subtitle: 'Pending..',
          icon: '/avatar.png'
        },
        {
          id: 3,
          title: 'Complete atleast one task',
          subtitle: 'Pending..',
          icon: '/complete_task.png'
        }
      ];

# Events

- `onItemClick` - This function is called when the user clicks on the row. The current `item` is passed down as an argument to the function.

- `itemActionClick` - This function is called when the `action` icon is clicked on the row.  The current `item` is passed down as an argument to the function.

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