Skip to main content

Introducing Workflow Engine, try for FREE workflowengine.io.

Checkbox

Introduction

The Checkbox component allows your users to confirm or agree with your provided statement. This component is useful for gathering a simple "yes" or "no" response to a question, such as agreeing to terms and conditions or opting in to a newsletter. Checkboxes can be also used in groups, which allow your users to select one or more values from a set. This component is a part of @react-form-builder/components-rsuite.

You can customize a checkbox component to fit your needs by using available options and properties that are introduced and described below.

Main properties

The following general properties are available within the Main tab:

NameTypeDescription
LabelstringText that is displayed for your checkbox
CheckedbooleanMakes your checkbox checked or unchecked by default
DisabledbooleanIf set to true, makes your checkbox inactive
Read OnlybooleanIf set to true, makes your checkbox unavailable to interact with
IndeterminatebooleanWhen being a checkbox, setting styles after the child part is selected. In other words, when a checkbox is partially checked, this property controls whether to apply a specific visual style to it
InlinebooleanSwitches to the inline layout
TitlestringUsed to enter HTML title for your checkbox

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

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:

    NameTypeDescription
    WidthnumberSpecifies the width for your component
    HeightnumberSpecifies the height for your component
    Margin top/right/bottom/leftnumberMargin values for you component
    ColorstringAllows customizing the text color
    Background colorstringEnables customizing the background color