boundless-checkbox-group

CheckboxGroup

A controller view for managing the aggregate state of multiple, related checkboxes.

The most common use case for CheckboxGroup is a "select all" / children scenario. This particular configuration is built-in and is activated by passing the selectAll prop.

Example Usage

import React from 'react';
import CheckboxGroup from '../index';
import {filter, map, merge, some} from 'lodash';

export default class CheckboxGroupDemo extends React.PureComponent {
    state = {
        items: [{
            inputProps: {
                checked: false,
                name: 'likes-science',
            },
            label: 'Science',
        }, {
            inputProps: {
                checked: false,
                name: 'likes-math',
            },
            label: 'Mathematics',
        }, {
            inputProps: {
                checked: false,
                name: 'likes-tech',
            },
            label: 'Technology',
        }, {
            inputProps: {
                checked: false,
                name: 'likes-art',
            },
            label: 'Art',
        }, {
            inputProps: {
                checked: false,
                name: 'likes-sports',
            },
            label: 'Sports',
        }],
    }

    mutateAll(delta) {
        this.setState({
            items: map(this.state.items, function transformer(item) {
                return merge({}, item, delta);
            }),
        });
    }

    mutateOne(name, delta) {
        this.setState({
            items: map(this.state.items, function transformer(item) {
                if (item.inputProps.name !== name) {
                    return item;
                }

                return merge({}, item, delta);
            }),
        });
    }

    handleAllChecked = () => {
        this.mutateAll({inputProps: {checked: true}});
    }

    handleAllUnchecked = () => {
        this.mutateAll({inputProps: {checked: false}});
    }

    handleChildChecked = (name) => {
        this.mutateOne(name, {inputProps: {checked: true}});
    }

    handleChildUnchecked = (name) => {
        this.mutateOne(name, {inputProps: {checked: false}});
    }

    renderFeedback() {
        if (some(this.state.items, {inputProps: {checked: true}})) {
            const liked = map(filter(this.state.items, {inputProps: {checked: true}}), 'label');
            const lastIndex = liked.length - 1;

            return (
                <p>You said you like: {liked.length === 1 ? liked[0] : [liked.slice(0, lastIndex).join(', '), 'and', liked.slice(lastIndex)].join(' ')}.</p>
            );
        }
    }

    render() {
        return (
            <div>
                <p>What subjects are you interested in?</p>
                <CheckboxGroup
                    className='checkbox-group-demo'
                    items={this.state.items}
                    selectAll={CheckboxGroup.selectAll.AFTER}
                    selectAllProps={{label: 'All of the above'}}
                    onAllChecked={this.handleAllChecked}
                    onAllUnchecked={this.handleAllUnchecked}
                    onChildChecked={this.handleChildChecked}
                    onChildUnchecked={this.handleChildUnchecked} />
                    <br />
                {this.renderFeedback()}
            </div>
        );
    }
}

Props

Note: only top-level props are in the README, for the full list check out the website.

Required Props

• items ・ the data wished to be rendered, each item must conform to the Checkbox prop spec

  Expects | Default Value

  •   | -
    

  array | []

Optional Props

• * ・ any React-supported attribute

  Expects | Default Value

  •   | -
    

  any | n/a

• component ・ override the wrapper HTML element if desired

  Expects | Default Value

  •   | -
    

  string | 'div'

• onAllChecked ・ called when all children become checked (not fired on first render), no return

  Expects | Default Value

  •   | -
    

  function | () => {}

• onAllUnchecked ・ called when all children become unchecked (not fired on first render), no return

  Expects | Default Value

  •   | -
    

  function | () => {}

• onChildChecked ・ called when a specific child has become checked, returns the child definition

  Expects | Default Value

  •   | -
    

  function | () => {}

• onChildUnchecked ・ called when a specific child has become checked, returns the child definition

  Expects | Default Value

  •   | -
    

  function | () => {}

• selectAll ・ renders a master checkbox that can manipulate the values of all children simultaneously

  Expects | Default Value

  •   | -
    

  CheckboxGroup.selectAll.BEFORE or CheckboxGroup.selectAll.AFTER or CheckboxGroup.selectAll.NONE | CheckboxGroup.selectAll.BEFORE

• selectAllProps ・ must conform to the Checkbox prop spec

  Expects | Default Value

  •   | -
    

  object | {}

Reference Styles

Stylus

// Bring in Boundless's base Stylus variables
@require "node_modules/boundless-checkbox-group/variables"

// Redefine any variables as desired, e.g.
color-accent = royalblue

// Bring in the component styles; they will be autoconfigured based on the above
@require "node_modules/boundless-checkbox-group/style"

CSS

If desired, a precompiled plain CSS stylesheet is available for customization at /build/style.css, based on Boundless's default variables.