Toggle

Introduction

The Toggle represents a binary switch that allows users to toggle between two states, typically representing an on/off or true/false condition. The toggle component provides a visual indicator and allows users to easily switch between the two states with a single click or tap. It is commonly used as visual representation of consent or agreement, show or hide content, and so on.

This component is a part of @react-form-builder/components-rsuite. You can customize this component to fit your design and requirements by using various options and properties that are introduced and described below.

Main properties

The following general properties are available within the Main tab:

Name	Type	Description
Label	string	Text that is displayed alongside the toggle
Checked	boolean	Makes your toggle active or inactive by default
Checked text	string	Text to display when the toggle is in the active state
Unchecked text	string	Text to display when the toggle is in the inactive state
Disabled	boolean	If set to true, makes your component inactive
Read Only	boolean	If set to true, makes your checkbox unavailable to interact with
Size	choice	Sets the size of the component (e.g., large, small, etc.)
Color	choice	Sets the color of the component (e.g., red, blue, etc.)
Loading	boolean	If set to true, displays a loading indicator on the toggle

At the bottom of the Main properties menu, you can find additional options:

• Render When: Provides conditional rendering for your calendar as described in the corresponding chapter.
• HTML attributes: Allows you to provide custom HTML attributes for your form.

Style properties

These are properties that allow to customize the size, color and other style properties of your component:

• For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.

• Component > Class Name: Add a class name for your component for the subsequent styling if necessary.

• Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:

  Name	Type	Description
  Width	number	Specifies the width for your component
  Height	number	Specifies the height for your component
  Margin top/right/bottom/left	number	Margin values for you component
  Color	string	Allows customizing the text color
  Background color	string	Enables customizing the background color