# @hmans/use-list

> A simple `useList` hook for simple reactive lists management.

Latest version **0.0.1** (published 2022-08-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hmans/use-list
pnpm add @hmans/use-list
yarn add @hmans/use-list
bun add @hmans/use-list
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2022-08-22 |
| First published | 2022-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 13 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Hendrik Mans |
| Maintainers | hendrik.mans |

## Links

- npm: https://www.npmjs.com/package/@hmans/use-list
- npm.io page: https://npm.io/package/@hmans/use-list

## Recent versions

- 0.0.1 (latest) — 2022-08-22

## README

# @hmans/use-list

## Summary

`useList` returns a reactive list of items together with functions to add and remove items to and from the list.

```tsx
const [list, addItem, removeItem, setList] = useList<T>()
```

If no argument is passed, the list will be initialized as an array of the given type, but you can also pass an initial value:

```tsx
useList([thing1, thing2])
```

Or pass a constructor function:

```tsx
useList(() => [thing1, thing2])
```

## Example

```tsx
import { useList } from "@hmans/use-list"

export const provideModuleRegistration = () => {
  const [things, addThing, removeThing] = useList<Thing>()

  return (
    <div>
      <button onClick={() => addThing(new Thing())} />
      <ul>
        {things.forEach((thing) => (
          <li>
            {thing.name}
            <button onClick={() => removeThing(thing)} />
          </li>
        ))}
      </ul>
    </div>
  )
}
```

## License

```
Copyright (c) 2022 Hendrik Mans

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```

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