ship-components-checkbox v1.0.1

ship-components-checkbox

React checkbox component. Exports a commonjs module that can be used with webpack or browserify. Source is in ES6 and is compiled down to ES5 using Babel.

Usage

ES6/JSX (Recommended)

The component is written using ES6/JSX therefore Babel is required to directly use it. The below example is based on using webpack and babel-loader.

import React from 'react';
import Checkbox, {RadioBox, RadioBoxGroup} from 'ship-components-checkbox';

export default class Form extends React.Component {
  constructor(props) {
    super(props);
    this.state = {
      selected: props.initialState,
      type: props.initialType
    };
  }

  handleChange(event) {
    this.setState({
      selected: event.target.value
    });
  }

  handleChangeType(event) {
    this.setState({
      type: event.target.value
    });
  }

  render() {
    return (
        <div className='form-group'>
          {/* Checkbox Example */}
          <CheckBox
            label='Enable buggy code'
            selected={this.state.selected}
            onChange={this.handleChange.bind(this)}
          />

          {/* Radiobox Example */}
          <RadioBoxGroup
           defaultValue={this.state.type}
           onChange={this.handleChangeType.bind(this)}
          >
            <RadioBox
              value="1"
              label="Card"
            />
            <RadioBox
              value="2"
              label="Boat"
            />
          </RadioBoxGroup>
        </div>
    );
  }
}

Webpack Configuration

This module is designed to be used with webpack but requires a few loaders.

npm install webpack babel-loader css-loader style-loader postcss-loader extract-text-webpack-plugin --save-dev

Below are is a sample of how to setup the loaders:

/**
 * Relevant Webpack Configuration
 */
{
  [...]
  module: {
    loaders: [
      // Setup support for ES6
      {
        test: /\.(jsx?|es6)$/,
        exclude: /(node_modules|bower_components)/,
        loader: 'babel'
      },
      // Setup support for CSS Modules
      {
        test: /\.css$/,
        loader: ExtractTextPlugin.extract('style-loader', 'css-loader?modules&importLoaders=1&localIdentName=[name]__[local]___[hash:base64:5]!postcss-loader')
      }
    ]
  },
  plugins: [
    // Extract the css and put it in one file. Path is relative to output path
    new ExtractTextPlugin('../css/[name]-modules.css', { allChunks: true })
  ],
  [...]
}

Tests

There's currently a bug in Jest, so the units tests and they will not run.

1. npm install
2. npm test

History

• 1.0.1 - Update to use react-transition-group (for React 16 compatibility)
• 1.0.0 - Update to use prop-types (for React 16 compatibility)
• 0.2.0 - Updates to the latest babel configurations (babel-preset-env)
• 0.1.5 - Fixes the tests, adds coveralls and Travis CI
• 0.1.4 - Removes the defaultValue prop from to fix the React 15.2+ warnings
• 0.1.3 - Minor css update on icon height
• 0.1.0 - Initial

License

The MIT License (MIT)

Copyright (c) 2016 SHIP

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.