# @feizheng/react-ant-checkbox-group

> React ant checkbox group.

Latest version **1.1.1** (published 2020-04-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @feizheng/react-ant-checkbox-group
pnpm add @feizheng/react-ant-checkbox-group
yarn add @feizheng/react-ant-checkbox-group
bun add @feizheng/react-ant-checkbox-group
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

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

## Links

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

## Dependencies (5)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [autoprefixer](https://npm.io/package/autoprefixer.md) ^9.7.4
- [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.1.1 (latest) — 2020-04-09
- 1.0.1 — 2019-12-02
- 1.0.0 — 2019-12-02

## README

# react-ant-checkbox-group
> React ant checkbox group.

## installation
```shell
npm install -S @feizheng/react-ant-checkbox-group
```

## update
```shell
npm update @feizheng/react-ant-checkbox-group
```

## properties
| Name      | Type   | Required | Default | Description                           |
| --------- | ------ | -------- | ------- | ------------------------------------- |
| className | string | false    | -       | The extended className for component. |
| value     | array  | false    | []      | Default value.                        |
| onChange  | func   | false    | noop    | The change handler.                   |
| items     | array  | false    | []      | The checkbox data source.             |
| template  | func   | true     | -       | The item template.                    |


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

  // customize your styles:
  $react-ant-checkbox-group-options: ()
  ```
2. import js
  ```js
  import ReactAntCheckboxGroup from '@feizheng/react-ant-checkbox-group';
  import ReactDOM from 'react-dom';
  import React from 'react';
  import { Checkbox } from 'antd';
  import './assets/style.scss';

  const DEFAULT_TEMPLATE = ({ item }) => {
    return (
      <Checkbox key={item.value} value={item.value}>
        {item.label}
      </Checkbox>
    );
  };

  class App extends React.Component {
    state = {
      items: [
        { value: 'k1', label: 'label1' },
        { value: 'k2', label: 'label2' },
        { value: 'k3', label: 'label3' }
      ]
    };

    onChange = (inEvent) => {
      console.log('chk change:', inEvent.target.value);
    };

    render() {
      return (
        <div className="app-container">
          <ReactAntCheckboxGroup
            name="abc"
            onChange={this.onChange}
            items={this.state.items}
            template={DEFAULT_TEMPLATE}
          />
        </div>
      );
    }
  }

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

  ```

## documentation
- https://afeiship.github.io/react-ant-checkbox-group/

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