Checkbox

UsageExamples
• API

Import

import { Checkbox } from '@resultadosdigitais/tangram-components'

Properties

Note: we don't use the required props of context for checkbox, once it is applied can be a trouble for multiples elements. It must be controlled outside.

checked

Type	bool

Description

Defines the Checkbox state. Used for Controlled component.

defaultChecked

Type	bool

Description

Sets the Checkbox checked by default. Used for Uncontrolled component.

disabled

Type	bool
Default	false

Description

Disables the Checkbox.

required

Type	bool
Default	false

Description

Sets if some value is required.

id

Type	string

Description

Sets the id.

indeterminate

Type	bool
Default	false

Description

Switch Checkbox icon between checkmark and indeterminate.

error

Type	bool
Default	false

Description

Sets error style.

label

Type	node

Description

Sets the label.

onChange

Type	func
Param	event React.SyntheticEvent - The event source of the callback.
Param	newStatus boolean - The new status about if is checked.

Description

Callback fired when the pagination changes.

rootRef

Type	func | shape
Default	null

Description

Pass a ref to the element wrapper.

size

Type	Enum of: Checkbox.sizes.md Checkbox.sizes.lg
Default	Checkbox.sizes.md

Description

Sets the Checkbox size.

Feedback

To report a problem or suggest changes, use our improvements form or, if you prefer, open an issue on our Github repository.