Module: Checkbox

A checkbox input component.

Parameters:

Name Type Description

props

object

Component props.

Properties

Name	Type	Description
`customAttributes`	object	Custom attributes for the component.
`customClasses`	string \| Array \| object	Custom classes for the component.
`disabled`	boolean	If checkbox is disabled.
`externalChecked`	boolean	If checkbox is checked or not, can change current checked state if changed.
`externalControl`	boolean	If checkbox is controlled externally.
`helpTextAttributes`	object	Custom attribute for the help text.
`id`	string	Optional id. Auto generated if not passed.
`indeterminate`	boolean	If checkbox is indeterminate, only works if externally controlled.
`initialChecked`	boolean	Whether it is checked on initial render.
`labelAttributes`	object	Custom attributes for the label.
`name`	string	The name attribute for the checkbox.
`onBlur`	function	On blur function handler.
`onChange`	function	On change function handler.
`onFocus`	function	On focus function handler.
`size`	string	The checkbox size, small (`size-sm`) or medium (`size-md`).
`spacing`	string \| number \| Array \| object	The spacing for the component, as a string, number, array, or object.
`theme`	string	The theme of the checkbox.
`value`	string	The checkbox value.
`wrapperAttributes`	object	Custom attributes for the wrapper element.
`wrapperClasses`	string \| Array \| object	Custom classes for the wrapper element.
`wrapperTagName`	string	Tag to use for the checkbox wrapper. Defaults to `div`.

ref

object | null

Ref to the component.

Since: 1.1.15
Source: elements/Checkbox/index.js, line 9

Returns:

The checkbox component.

Type:: JSX.Element

Example

import Checkbox from '@gravityforms/components/react/admin/elements/Checkbox';

return (
    <Checkbox />
        checked={ true }
        labelAttributes={ {
            label: 'Check me!',
        } }
        id="checkbox"
        onChange={ () => {} }
    />
);