react-toggle

What is react-toggle?

The react-toggle package is a React component that provides a highly customizable toggle switch. It is used to create toggle buttons that can switch between two states, such as on/off or true/false. The package is lightweight and easy to integrate into any React application.

What are react-toggle's main functionalities?

Basic Toggle

This code demonstrates a basic toggle switch using the react-toggle package. The toggle is initially set to the 'off' state.

import React from 'react';
import Toggle from 'react-toggle';
import 'react-toggle/style.css';

function App() {
  return (
    <div>
      <label>
        <Toggle defaultChecked={false} />
        <span>Toggle me</span>
      </label>
    </div>
  );
}

export default App;

Custom Icons

This code demonstrates how to use custom icons for the toggle switch. The toggle shows a moon icon when checked and a sun icon when unchecked.

import React from 'react';
import Toggle from 'react-toggle';
import 'react-toggle/style.css';

function App() {
  return (
    <div>
      <label>
        <Toggle
          defaultChecked={true}
          icons={{
            checked: <span>🌜</span>,
            unchecked: <span>🌞</span>
          }}
        />
        <span>Toggle with custom icons</span>
      </label>
    </div>
  );
}

export default App;

Disabled Toggle

This code demonstrates a disabled toggle switch. The toggle is set to the 'on' state and cannot be changed by the user.

import React from 'react';
import Toggle from 'react-toggle';
import 'react-toggle/style.css';

function App() {
  return (
    <div>
      <label>
        <Toggle defaultChecked={true} disabled={true} />
        <span>Disabled toggle</span>
      </label>
    </div>
  );
}

export default App;

Other packages similar to react-toggle

rc-switch

The rc-switch package is another React component for creating toggle switches. It offers similar functionality to react-toggle but with a different set of customization options and styles. It is part of the rc-components library, which provides a variety of reusable React components.

react-switch

The react-switch package provides a customizable toggle switch component for React. It offers a similar feature set to react-toggle, including custom icons and disabled states. It is known for its ease of use and flexibility in styling.

react-toggle-switch

The react-toggle-switch package is another alternative for creating toggle switches in React applications. It provides a simple API and allows for easy customization of the switch's appearance and behavior. It is a lightweight option for developers looking for basic toggle functionality.

README

An elegant, accessible toggle component for React. Also a glorified checkbox.

See usage and examples.

Props

The component takes the following props.

Prop	Type	Description
checked	boolean	If true, the toggle is checked. If false, the toggle is unchecked. Use this if you want to treat the toggle as a controlled component
defaultChecked	boolean	If true on initial render, the toggle is checked. If false on initial render, the toggle is unchecked. Use this if you want to treat the toggle as an uncontrolled component
onChange	function	Callback function to invoke when the user clicks on the toggle. The function signature should be the following: function(e) { }. To get the current checked status from the event, use e.target.checked.
onFocus	function	Callback function to invoke when field has focus. The function signature should be the following: function(e) { }
onBlur	function	Callback function to invoke when field loses focus. The function signature should be the following: function(e) { }
name	string	The value of the name attribute of the wrapped <input> element
value	string	The value of the value attribute of the wrapped <input> element
id	string	The value of the id attribute of the wrapped <input> element
icons	object	If false, no icons are displayed. You may also pass custom icon components in icons={{checked: <CheckedIcon />, unchecked: <UncheckedIcon />}}
aria-labelledby	string	The value of the aria-labelledby attribute of the wrapped <input> element
aria-label	string	The value of the aria-label attribute of the wrapped <input> element
disabled	boolean	If true, the toggle is disabled. If false, the toggle is enabled

Installation

npm install react-toggle

Usage

If you want the default styling, include the component's CSS with

import "react-toggle/style.css" // for ES6 modules
// or
require("react-toggle/style.css") // for CommonJS

Development

npm install
npm run dev

Build

npm run build

License

MIT