@humanmade/react-tasklist

react-tasklist

Simple task lists in React.

Installation

npm install --save @humanmade/react-tasklist

Usage

import Tasklist from '@humanmade/react-tasklist';

import '@humanmade/react-tasklist/css/index.css';

class MyComponent extends React.Component {
	constructor( props ) {
		super( props );

		this.state = {
			items: [
				{
					label: 'Item one',
					checked: false,
				},
				{
					label: 'Item two',
					checked: false,
					disabled: true,
				},
				{
					label: 'Item three',
					checked: true,
				},
			],
		};
	}

	onChange = ( index, checked ) => {
		const { items } = this.state;
		this.setState( {
			items: [
				...items.slice( 0, index ),
				{ ...items[ index ], checked },
				...items.slice( index + 1 )
			],
		} );
	}

	render() {
		const { items } = this.state;

		return <Tasklist
			items={ items }
			onChange={ this.onChange }
			onReorder={ items => this.setState( { items } ) }
		/>
	}

Props API

items

A sorted list of items to display on the list. Each item is an object with the following properties:

• label (required, string|ReactElement): Label for the item. May be a React element.
• task (boolean, default true): Is this a task item? Set to false for regular list items.
• checked (required, boolean): Checkbox state.
• disabled (boolean, default false): Is the checkbox disabled?
• id (string, default label): Unique ID for the item. Value of label by default.

disableSort

Boolean

Whether sorting is disabled (e.g. for users without permission to edit the list).

onChange

( index: Number, checked: Boolean ) => void

Callback function for when the checked state of an item changes. Passed following parameters:

• index (Number): Index of the item which changed.
• checked (Boolean): True if the new state is checked, false if the new state is unchecked.

onReorder

( items: Array, oldIndex: Number, newIndex: Number ) => void

Callback function for when items are reordered. This receives the reordered items for convenience, but you can use the oldIndex and newIndex parameters to manually reorder your items if you'd prefer.

Passed following parameters:

• items (Array): Reordered list of items.
• oldIndex (Number): Index of the item in the original array.
• newIndex (Number): Index of the item in the new array.