# react-toggle-filter

> Simple React component for filtering items via toggles.

Latest version **0.0.6** (published 2018-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-toggle-filter
pnpm add react-toggle-filter
yarn add react-toggle-filter
bun add react-toggle-filter
```

## 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.6 |
| Published | 2018-09-26 |
| First published | 2018-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 25.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Harun Djulic |
| Maintainers | harund |

## Links

- npm: https://www.npmjs.com/package/react-toggle-filter
- Repository: https://github.com/HarunD/react-toggle-filter
- Issues: https://github.com/HarunD/react-toggle-filter/issues
- npm.io page: https://npm.io/package/react-toggle-filter

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^16.2.0
- [css-loader](https://npm.io/package/css-loader.md) ^0.28.11
- [@types/react](https://npm.io/package/@types/react.md) ^16.0.40
- [style-loader](https://npm.io/package/style-loader.md) ^0.20.3

## Recent versions

- 0.0.6 (latest) — 2018-09-26
- 0.0.55 — 2018-03-21
- 0.0.5 — 2018-03-21
- 0.0.42 — 2018-03-21
- 0.0.41 — 2018-03-20
- 0.0.4 — 2018-03-20
- 0.0.32 — 2018-03-20
- 0.0.31 — 2018-03-20
- 0.0.3 — 2018-03-20

## README

# react-toggle-filter
A component for filter control using toggles with easily customizable styling.

<img src="demo.gif">

## Installation

```
yarn add react-toggle-filter
```

or

```
npm install react-toggle-filter
```

## Running a Demo
To run a local demo of `react-toggle-filter`:
- clone this repo
- install dependencies
- run `yarn storybook`.

## Usage
For basic use provide an array of strings to use as filter options and a handler function for `onItemToggle` callback:

```
<ToggleFilter
    items={['Open', 'Resolved', 'Closed']}
    onItemToggle={
        (selectedItems, allItems) => {
            console.log('Selected items:', selectedItems);
        }
    }/>
```

More detailed examples can be found in `stories/index.js`.

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