Getting Started

20 Mar 20233 minutes to read

This section explains how to create a simple CheckBox, and configure its available functionalities in React, using React quickstart application.

Dependencies

The following list of dependencies are required to use the CheckBox component in your application.

|-- @syncfusion/ej2-react-buttons
    |-- @syncfusion/ej2-react-base
    |-- @syncfusion/ej2-base
    |-- @syncfusion/ej2-buttons

Installation and Configuration

You can use Create-react-app to setup the applications. To install create-react-app run the following command.

     npm install -g create-react-app

Start a new project using create-react-app command as follows

<div class='tsx'>
```bash
  create-react-app quickstart --scripts-version=react-scripts-ts
  cd quickstart
```

</div>

‘react-scripts-ts’ is used for creating React app with typescript.

Adding Syncfusion packages

All the available Essential JS 2 packages are published in npmjs.com public registry.

To install CheckBox component, use the following command

npm install @syncfusion/ej2-react-buttons --save

Adding CheckBox component to the Application

To include the CheckBox component in your application import the CheckBoxComponent from ej2-react-buttons package in App.tsx.

Add the CheckBox component in application as shown in below code example.

import { CheckBoxComponent } from '@syncfusion/ej2-react-buttons';
import * as React from 'react';
import './App.css';
// Import the CheckBox.

// To render CheckBox.
function App() {
  render() {
    return (
      <CheckBoxComponent label="Default" />
    );
  }
}
export default App;

import { CheckBoxComponent } from '@syncfusion/ej2-react-buttons';
import * as React from 'react';
import './App.css';
// Import the CheckBox.
// To render CheckBox.
function App() {
    render();
    {
        return (<CheckBoxComponent label="Default"/>);
    }
}
export default App;

Adding CSS Reference

Import the CheckBox component’s required CSS references as follows in src/App.css.

@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-buttons/styles/material.css";

Running the application

Run the application in the browser using the following command:

    npm start

The following example shows a basic CheckBox component.

import { enableRipple } from '@syncfusion/ej2-base';
import { CheckBoxComponent } from '@syncfusion/ej2-react-buttons';
import * as React from 'react';
import * as ReactDom from 'react-dom';
enableRipple(true);
// To render CheckBox.
function App() {
    return (<CheckBoxComponent label="Default"/>);
}
export default App;
ReactDom.render(<App />, document.getElementById('check-box'));

import { enableRipple } from '@syncfusion/ej2-base';
import { CheckBoxComponent } from '@syncfusion/ej2-react-buttons';
import * as React from 'react';
import * as ReactDom from 'react-dom';

enableRipple(true);

// To render CheckBox.
function App() {
  return (
    <CheckBoxComponent label="Default" />
  );
}
export default App;
ReactDom.render(<App />, document.getElementById('check-box'));

Preview Sample