# @feizheng/react-list

> A list component.

Latest version **1.0.3** (published 2020-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @feizheng/react-list
pnpm add @feizheng/react-list
yarn add @feizheng/react-list
bun add @feizheng/react-list
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-09-03 |
| First published | 2019-12-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 21 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | afei |
| Maintainers | afeiship |
| Keywords | react, component |

## Links

- npm: https://www.npmjs.com/package/@feizheng/react-list
- Repository: https://github.com/afeiship/react-list
- Homepage: https://github.com/afeiship/react-list#readme
- Issues: https://github.com/afeiship/react-list/issues
- npm.io page: https://npm.io/package/@feizheng/react-list

## Dependencies (4)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [object-assign](https://npm.io/package/object-assign.md) ^4.1.1
- [@feizheng/noop](https://npm.io/package/@feizheng/noop.md) ^1.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2020-09-03
- 1.0.2 — 2020-08-27
- 1.0.1 — 2019-12-19
- 1.0.0 — 2019-12-12

## README

# react-list
> A list component.

[![version][version-image]][version-url]
[![license][license-image]][license-url]
[![size][size-image]][size-url]
[![download][download-image]][download-url]

## installation
```shell
npm install -S @feizheng/react-list
```

## update
```shell
npm update @feizheng/react-list
```

## properties
| Name      | Type   | Required | Default | Description                                       |
| --------- | ------ | -------- | ------- | ------------------------------------------------- |
| className | string | false    | -       | The extended className for component.             |
| virtual   | bool   | false    | -       | If node name is React.Framgment.                  |
| nodeName  | any    | false    | 'div'   | Use customize node name(tagName or ReactElement). |
| items     | array  | false    | []      | List data source.                                 |
| template  | func   | false    | noop    | List item template.                               |


## usage
1. import css
  ```scss
  @import "~@feizheng/react-list/dist/style.scss";

  // customize your styles:
  $react-list-options: ()
  ```
2. import js
  ```js
  import React from 'react';
  import ReactDOM from 'react-dom';
  import ReactList from '@feizheng/react-list';
  import './assets/style.scss';

  class App extends React.Component {
    state = {
      items: require('./assets/data.json')
    };

    template = ({ item }) => {
      return (
        <div key={item.domId} className="is-item">
          {item.name}
        </div>
      );
    };

    render() {
      return (
        <div className="app-container">
          <ReactList items={this.state.items} template={this.template} />
        </div>
      );
    }
  }

  ReactDOM.render(<App />, document.getElementById('app'));

  ```

## documentation
- https://afeiship.github.io/react-list/


## license
Code released under [the MIT license](https://github.com/afeiship/react-list/blob/master/LICENSE.txt).

[version-image]: https://img.shields.io/npm/v/@feizheng/react-list
[version-url]: https://npmjs.org/package/@feizheng/react-list

[license-image]: https://img.shields.io/npm/l/@feizheng/react-list
[license-url]: https://github.com/afeiship/react-list/blob/master/LICENSE.txt

[size-image]: https://img.shields.io/bundlephobia/minzip/@feizheng/react-list
[size-url]: https://github.com/afeiship/react-list/blob/master/dist/react-list.min.js

[download-image]: https://img.shields.io/npm/dm/@feizheng/react-list
[download-url]: https://www.npmjs.com/package/@feizheng/react-list

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