react-checklist

React Hook Checkbox List.

• Typescript support
• Unopinionated
• No dependencies
• Tiny package size

Install

$ npm install react-checklist
or
$ yarn add react-checklist

Usage

Basic

import React from 'react';

import { useChecklist } from 'react-checklist';
// or const { useChecklist } = require('react-checklist');

const data = [
  { _id: 1, label: 'item 1' },
  { _id: 2, label: 'item 2' },
  { _id: 3, label: 'item 3' },
]

export default () => {
  const { handleCheck, isCheckedAll, checkedItems } = useChecklist(data, {
    key: '_id',
    keyType: 'number',
  });

  console.log(checkedItems);      // Set(0) - handling with Set
  console.log([...checkedItems]); // []     - handling with Array
  return (
    <ul>

      <li>
        <input
          type="checkbox"
          onChange={handleCheck}              // 1
          checked={isCheckedAll}              // 2
        />
        <label>Check All</label>
      </li>

      {data.map((v, i) => (
        <li key={i}>
          <input
            type="checkbox"
            data-key={v._id}                  // 3
            onChange={handleCheck}            // 4
            checked={checkedItems.has(v._id)} // 5
          />
          <label>{v.label}</label>
        </li>
      ))}

    </ul>
  );
};

Without Checkbox

<ul>

  <li>
    <button onClick={handleCheck}>
      {isCheckedAll ? 'Cancel' : 'Check All'}
    </button>
  </li>

  {data.map((v, i) => (
    <li key={i}>
      <span
        data-key={v._id}
        onClick={handleCheck}
        style={{ backgroundColor: checkedItems.has(v._id) ? 'hotpink' : 'white' }}
      >
        {v.label}
      </span>
    </li>
  ))}

</ul>

With Reset Button

export default () => {
  const { setCheckedItems } = useChecklist(data);

  const handleReset = () => setCheckedItems(new Set());

  return (
    <ul>

      <li>
        <button onClick={handleReset}>
          Reset
        </button>
      </li>

    </ul>
  );
};

Parameters

useChecklist(data, options)

data

Item list for check.
Type: Array

options

Type: Object

• key
  Unique key of item list for check.
  Type: String
  Default: 'id'

• keyType
  Type of key. You can define type for data-key value.
  Type: Enum 'string' | 'number'
  Default: 'string'

Return

isCheckedAll

You can get true or false that all item are checked or not.
Type: Boolean

checkedItems

Set of checked items.
Type: Set

setCheckedItems

Function for setting checkedItems state.
You can handling checked items for onRouteChanged Event with this function.
Type: (Set) => void

handleCheck

Trigger onChange event for item list.
Type: (Event) => void

Recommend Libraries

• React Store - React Hook Store with useContext and useReducer for State Management.
• React Quilljs - React Hook Wrapper for Quill(Rich Text Editor).
• Decode URI Component Charset - Decode URI Component with Charset such as 'euc-kr' without tears.

Maintainer

• Jehun Seem

License

MIT