ReactJS CheckBox Component

The CheckBox component for ReactJS represents a check box that allows the end-user to select a true, false or indeterminate condition.

Prerequisites

Refer to ReactJS Getting Started before you start with this help topic.

Configuration

The CheckBox component for ReactJS requires the following imports.

 
import React from 'react';
import ReactDOM from 'react-dom';
 
import JqxCheckBox from 'jqwidgets-react/react_jqxcheckbox.js';
 

Then we create our component class. Properties and methods are put as ReactJS props.

  
class App extends React.Component {
  render () {
    return (
       <JqxCheckBox 
           value='Health'
           width={120}
           height={25} 
      />
    )
  }
}
 

Finally we render our class in the desired HTML element:

 
ReactDOM.render(<App />, document.getElementById('app'));
 

Events Methods & Properties

In order to bind to any event, change any property or call any method, we need a reference to the component.
For that we use the ReactJS "ref" Callback Attribute:

 
<JqxCheckBox ref='myCheckBox' width={120} height={25}..... />
 

Now, when we have a reference, we need to call the desired event/property/method.
This is done in the componentDidMount() ReactJS Component Lifecycle method.

 
class App extends React.Component {
  componentDidMount()
  {
     //your logic
  }
  render ()
  {
    return
    (
      ....
    )
  }
};
 

Events

The change event is triggered when the checkbox's state changes.

The following example demonstrates how to add an event listener:

 
componentDidMount ()
{
 
  this.refs.myCheckBox.on('change', (event) =>
  {
     //your logic
  });
 
}
 

Methods & Properties

This is how you call methods & props:

Every component have a method setOptions which accepts a object as an argument. This object contains component settings.

Every component also have a method getOptions which returns a object containing the component settings.

CheckBox Examples

Overview

The following example demonstrates how to create a CheckBox component.

 
import React from 'react';
import ReactDOM from 'react-dom';
 
import JqxCheckBox from 'jqwidgets-react/react_jqxcheckbox.js';
 
class App extends React.Component {
  render () {
    return (
        <JqxCheckBox 
            value='Health'
            width={120}
            height={25} 
        />
    )
  }
}
 
ReactDOM.render(<App />, document.getElementById('app'));
 

Set Indeterminate CheckBox

The following example demonstrates the CheckBox in the indeterminate state. Use checked: null property.

CheckBox API