Checkbox

Source@react-form-builder/components-mantine

Introduction

The Checkbox component allows users to select one or multiple options from a set. It is commonly used for binary choices, agreement to terms, or selecting multiple items from a list. The component provides a visual representation of a checked/unchecked state with Mantine styling.

The Checkbox component is based on Mantine Checkbox. It is included within the following NPM package: @react-form-builder/components-mantine.

The Checkbox component can be styled and configured to fit specific design and functionality requirements by using various properties that are presented and described below.

Main properties

The following general properties are available within the Main tab:

Name	Type	Description
Label	string	Text displayed next to the checkbox
Checked	boolean	Sets the initial checked state (uncontrolled value)
Indeterminate	boolean	If true, shows indeterminate state
Label position	'left' | 'right'	Position of the label relative to the checkbox
Description	string	Helper text below the checkbox
Size	'xs' | 'sm' | 'md' | 'lg' | 'xl'	The size of the checkbox
Color	string	Mantine theme color or CSS color when checked
Variant	'filled' | 'outline'	The visual variant
Disabled	boolean	Disables the checkbox
On change	event	Fired when the checked state changes

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

• Render When: Provides conditional rendering for your component 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