Switch

UsageExamples
• API

Import

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

Properties

checked

Type	bool

Description

Sets the initial state. Used for Controlled component.

defaultChecked

Type	bool

Description

Sets the default value. Used for Uncontrolled component.

disabled

Type	bool
Default	false

Description

Sets if is disabled.

labelStart

Type	bool
Default	false

Description

Sets the label to be displayed at before the Switch.

hideLabel

Type	bool
Default	false

Description

Sets if the label is hidden.

id

Type	string

Description

Sets the id.

label

Type	node

Description

Sets the label.

value

Type	string

Description

Sets a value when Switch is checked.

onChange

Type	func
Param	newState boolean - The new state about if is checked.

Description

Callback fired when the Switch changes.

onFocus

Type	func
Param	event React.SyntheticEvent - The event source of the callback.

Description

Callback fired when the Switch is focused.

onBlur

Type	func
Param	event React.SyntheticEvent - The event source of the callback.

Description

Callback fired when the input is blurred.

rootRef

Type	func | shape
Default	null

Description

Pass a ref to the element wrapper.

required

Type	bool
Default	false

Description

Sets the switch as required.

Feedback

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