@opuscapita/react-checkbox

OpusCapita react component template

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
03Nov 2, 2019Mar 21, 2018Minified + gzip package size for @opuscapita/react-checkbox in KB

Readme

react-checkbox

Description

OpusCapita styled checkbox component

Installation

npm install @opuscapita/react-checkbox

Demo

View the DEMO

Builds

UMD

The default build with compiled styles in the .js file. Also minified version available in the lib/umd directory.

CommonJS/ES Module

You need to configure your module loader to use cjs or es fields of the package.json to use these module types. Also you need to configure sass loader, since all the styles are in sass format.

API

Prop name Type Default Description
onChange function required Callback function for checkbox
onFocus function () => {} onFocus callback function for checkbox
onBlur function () => {} onBlur callback function for checkbox
checked boolean false Is checked or not
className string Additional class for component
disabled boolean false Is disabled
id string ID attribute. Resulting element ID will be ${id}-checkbox
name string Name attribute
value string Value attribute
label string or node Checkbox label
tabIndex string 0 tabIndex

Code example

import React from 'react';
import Checkbox from '@opuscapita/react-checkbox';

export default class ReactView extends React.Component {
  render() {
    return (
      <Checkbox
        onChange={this.onChange}
      />
    );
  }
}

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.