Skip to content
Home

Toggle

Info
Demos
Properties
Events

Description

Field.Toggle is a base component for allowing the user to toggle between two different values in the target data point.

Demos

On state

<Field.Toggle

  valueOn="checked"

  valueOff="unchecked"

  variant="checkbox"

  label="Label text"

  value="checked"

  onChange={(value) => console.log('onChange', value)}

/>

Off state

<Field.Toggle

  valueOn="checked"

  valueOff="unchecked"

  variant="checkbox"

  label="Label text"

  value="unchecked"

  onChange={(value) => console.log('onChange', value)}

/>

No value

<Field.Toggle

  valueOn="checked"

  valueOff="unchecked"

  variant="checkbox"

  label="Label text"

  onChange={(value) => console.log('onChange', value)}

/>

Disabled

<Field.Toggle

  valueOn="checked"

  valueOff="unchecked"

  variant="checkbox"

  label="Label text"

  onChange={(value) => console.log('onChange', value)}

  disabled

/>

Info

Useful information (?)
<Field.Toggle

  valueOn="checked"

  valueOff="unchecked"

  variant="checkbox"

  label="Label text"

  onChange={(value) => console.log('onChange', value)}

  info="Useful information (?)"

/>

Warning

I'm warning you...
<Field.Toggle

  valueOn="checked"

  valueOff="unchecked"

  variant="checkbox"

  label="Label text"

  onChange={(value) => console.log('onChange', value)}

  warning={new FormError("I'm warning you...")}

/>

Error

This is what is wrong...
<Field.Toggle

  valueOn="checked"

  valueOff="unchecked"

  variant="checkbox"

  label="Label text"

  onChange={(value) => console.log('onChange', value)}

  error={new FormError('This is what is wrong...')}

/>

Value types

Boolean value - On state

<Field.Toggle

  valueOn={true}

  valueOff={false}

  variant="checkbox"

  label="Boolean value"

  value={true}

  onChange={(value) => console.log('onChange', value)}

/>

Boolean value - Off state

<Field.Toggle

  valueOn={true}

  valueOff={false}

  variant="checkbox"

  label="Boolean value"

  value={false}

  onChange={(value) => console.log('onChange', value)}

/>

Number value - On state

<Field.Toggle

  valueOn={100}

  valueOff={0}

  variant="checkbox"

  label="Number value"

  value={100}

  onChange={(value) => console.log('onChange', value)}

/>

Number value - Off state

<Field.Toggle

  valueOn={100}

  valueOff={0}

  variant="checkbox"

  label="Number value"

  value={0}

  onChange={(value) => console.log('onChange', value)}

/>

Variants

Button

<Field.Toggle

  valueOn="on"

  valueOff="off"

  variant="button"

  label="Toggle button variant"

  value="on"

  onChange={(value) => console.log('onChange', value)}

/>

Buttons

<Field.Toggle

  valueOn="on"

  valueOff="off"

  variant="buttons"

  label="Buttons variant"

  value="on"

  onChange={(value) => console.log('onChange', value)}

/>

Checkbox button

<Field.Toggle

  valueOn="on"

  valueOff="off"

  variant="checkbox-button"

  label="Toggle checkbox variant"

  value="on"

  onChange={(value) => console.log('onChange', value)}

/>

Properties

Standard input component props

PropertyTypeDescription
data-testidstring(optional) Test ID
classNamestring(optional) Outer DOM element class name
valueany(optional) Source data value for the input
layoutstring(optional) Layout for the label and input. Can be horizontal or vertical
labelstring(optional) Field label to show above / before the input feature
labelDescriptionstring(optional) A more discreet text displayed beside the label (i.e for "(optional)")
labelSecondarystring(optional) Secondary information displayed at the end of the label line (i.e character counter)
placeholderstring(optional) Text showing in place of the value if no value is given
pathstring(optional) JSON Pointer for where the data for this input is located in the source dataset (when using DataContext)
infoError or string(optional) Info message shown below / after the input
warningError or string(optional) Warning message shown below / after the input
errorError(optional) Error message shown below / after the input
disabledboolean(optional) Set true to show the field but without the possibility of changing the value.
emptyValueany(optional) The value to use (in onChange events etc) when emptying the field. Makes it possible for instance to provide undefined instead of an empty string when clearing the content of a text input.
requiredboolean(optional) When set true, the input will give an error if the value cannot be empty.
schemaobject(optional) Custom JSON Schema for validating the value.
validateInitiallystring(optional) Set true to show validation based errors initially (from given value-prop or source data) before the user interacts with the field.
validateUnchangedstring(optional) Set true to show validation based errors when the field is touched (like focusing a field and blurring) without having changed the value. Since the user did not introduce a new error, this will apply when the value was initially invalid based on validation.
continuousValidationstring(optional) Set true to show validation based errors continuously while writing, not just when blurring the field.
errorMessagesobject(optional) Custom error messages for each type of error, overriding default messages.
validatorfunction(optional) Custom validator function that will be called for every change done by the user. Can be asynchronous or synchronous.
onBlurValidatorfunction(optional) Custom validator function that will be called when the user leaves the field (blurring a text input, closing a dropdown etc). Can be asynchronous or synchronous.
toInputfunction(optional) Derivate called when the received / active value is sent to the input. Can be used for casting, changing syntax etc.
fromInputfunction(optional) Derivate called when changes is made by the user, to cast or change syntax back to the original (opposite of toInput).

Component-specific props

PropertyTypeDescription
valueOnstring, number, boolean(required) Source data value when the toggle is in the "on-state" (varies based on UI variant).
valueOffstring, number, boolean(required) Source data value when the toggle is in the "off-state".
textOnstring(optional) Text to show in the UI when in the "on-state".
textOffstring(optional) Text to show in the UI when in the "off-state".
variantstring(optional) Choice of input feature. Can be: checkbox, button, checkbox-button or buttons

Events

EventDescription
onChange(optional) Will be called on value changes made by the user, with the new value as argument.
onFocus(optional) Will be called when the component gets into focus. Like clicking inside a text input or opening a dropdown. Called with active value as argument.
onBlur(optional) Will be called when the component stop being in focus. Like when going to next field, or closing a dropdown. Called with active value as argument.