---
title: 'Field.Boolean'
description: '`Field.Boolean` is the base component for receiving user input where the target data is of type `boolean`.'
version: 0.0.0-development
generatedAt: 2026-06-12T14:12:21.461Z
checksum: 090b7d977ba4be5e2c4c04d199a30a4048416c59f443a56985df2f80629d9c40
---

# Field.Boolean

## Import

```tsx
import { Field } from '@dnb/eufemia/extensions/forms'
render(<Field.Boolean />)
```

## Description

`Field.Boolean` is the base component for receiving user input where the target data is of type `boolean`.

Before using this component, ensure there is not a more specific [field component](/uilib/extensions/forms/feature-fields/) available that better suits your needs.

There is a corresponding [Value.Boolean](/uilib/extensions/forms/Value/Boolean) component.

```tsx
import { Field } from '@dnb/eufemia/extensions/forms'
render(<Field.Boolean path="/myState" />)
```

## Relevant links

- [Source code](https://github.com/dnbexperience/eufemia/tree/main/packages/dnb-eufemia/src/extensions/forms/base-fields/Boolean)
- [Docs code](https://github.com/dnbexperience/eufemia/tree/main/packages/dnb-design-system-portal/src/docs/uilib/extensions/forms/base-fields/Boolean)

## Indeterminate checkbox

Here is an indeterminate state (partially checked) [working example](/uilib/extensions/forms/base-fields/Indeterminate/).

## Schema validation

You can use a schema to validate the value with either `const` or `enum`.

**Using Zod schemas**

```tsx
import { Form, Field, z } from '@dnb/eufemia/extensions/forms'

const schema = z.object({
  myField: z.literal(true), // or z.enum([true])
})

render(
  <Form.Handler schema={schema} data={{ myField: false }}>
    <Field.Boolean path="/myField" />
  </Form.Handler>
)
```

**Using JSON Schema (Ajv)**

```tsx
import {
  Form,
  Field,
  makeAjvInstance,
} from '@dnb/eufemia/extensions/forms'

const ajv = makeAjvInstance()
const schema = {
  type: 'object',
  properties: {
    myField: {
      type: 'boolean',
      const: true, // or enum: [true]
    },
  },
}

render(
  <Form.Handler
    schema={schema}
    ajvInstance={ajv}
    data={{ myField: false }}
  >
    <Field.Boolean path="/myField" />
  </Form.Handler>
)
```


## Demos

### No label or value


```tsx
render(<Field.Boolean onChange={value => console.log('onChange', value)} />)
```


### Checkbox

#### Value true


```tsx
render(<Field.Boolean variant="checkbox" label="Label text" value={true} onChange={value => console.log('onChange', value)} />)
```


#### Value false


```tsx
render(<Field.Boolean variant="checkbox" label="Label text" value={false} onChange={value => console.log('onChange', value)} />)
```


#### Checkbox - Required


```tsx
render(<Field.Boolean variant="checkbox" label="Set to be required initially" onChange={value => console.log('onChange', value)} validateInitially required />)
```


#### Checkbox - Disabled


```tsx
render(<Field.Boolean variant="checkbox" label="I am disabled" onChange={value => console.log('onChange', value)} disabled />)
```


### Checkbox - prevent changing the state of the checkbox

You can prevent the state of the checkbox from changing by calling `preventDefault` on the `onClick` event.


```tsx
render(<Field.Boolean variant="checkbox" label="I will never change the state" onClick={(value, {
  event
}) => {
  event.preventDefault();
}} onChange={value => console.log('onChange', value)} />)
```


#### Checkbox - Error


```tsx
render(<Field.Boolean variant="checkbox" label="Label text" onChange={value => console.log('onChange', value)} error={new Error('This is what is wrong...')} />)
```


### Checkbox - With Help


```tsx
render(<Field.Boolean variant="checkbox" label="Checkbox variant" help={{
  title: 'Help title',
  content: 'Help content'
}} />)
```


### Button

#### Value true


```tsx
render(<Field.Boolean variant="button" label="Label text" value={true} onChange={value => console.log('onChange', value)} />)
```


#### Button - Value false


```tsx
render(<Field.Boolean variant="button" label="Label text" value={false} onChange={value => console.log('onChange', value)} />)
```


#### Button - Required


```tsx
render(<Field.Boolean variant="button" label="Set to be required initially" onChange={value => console.log('onChange', value)} validateInitially required />)
```


#### Button - Disabled


```tsx
render(<Field.Boolean variant="button" label="I am disabled" onChange={value => console.log('onChange', value)} disabled />)
```


#### Button - Error


```tsx
render(<Field.Boolean variant="button" label="Label text" onChange={value => console.log('onChange', value)} error={new Error('This is what is wrong...')} />)
```


### Checkbox button

#### Value true


```tsx
render(<Field.Boolean variant="checkbox-button" label="Label text" value={true} onChange={value => console.log('onChange', value)} />)
```


#### Checkbox button - Value false


```tsx
render(<Field.Boolean variant="checkbox-button" label="Label text" value={false} onChange={value => console.log('onChange', value)} />)
```


#### Checkbox button - Required


```tsx
render(<Field.Boolean variant="checkbox-button" label="Set to be required initially" onChange={value => console.log('onChange', value)} validateInitially required />)
```


#### Checkbox button - Disabled


```tsx
render(<Field.Boolean variant="checkbox-button" label="I am disabled" onChange={value => console.log('onChange', value)} disabled />)
```


#### Checkbox button - Error


```tsx
render(<Field.Boolean variant="checkbox-button" label="Label text" onChange={value => console.log('onChange', value)} error={new Error('This is what is wrong...')} />)
```


### Buttons

#### Value true


```tsx
render(<Field.Boolean variant="buttons" label="Label text" value={true} onChange={value => console.log('onChange', value)} />)
```


#### Buttons - Value false


```tsx
render(<Field.Boolean variant="buttons" label="Label text" value={false} onChange={value => console.log('onChange', value)} />)
```


#### Button - Value undefined (no option selected)


```tsx
render(<Field.Boolean variant="buttons" label="Label text" onChange={value => console.log('onChange', value)} />)
```


#### Buttons - Required


```tsx
render(<Field.Boolean variant="buttons" label="Set to be required initially" onChange={value => console.log('onChange', value)} validateInitially required />)
```


#### Buttons - With Help


```tsx
render(<Field.Boolean variant="buttons" label="Buttons variant" help={{
  title: 'Help title',
  content: 'Help content'
}} />)
```


#### Buttons - Disabled


```tsx
render(<Field.Boolean variant="buttons" label="I am disabled" onChange={value => console.log('onChange', value)} disabled />)
```


#### Buttons - Error


```tsx
render(<Field.Boolean variant="buttons" label="Label text" onChange={value => console.log('onChange', value)} error={new Error('This is what is wrong...')} />)
```


### Radio

#### Value true


```tsx
render(<Field.Boolean variant="radio" label="Label text" value={true} onChange={value => console.log('onChange', value)} />)
```


#### Radio - Value false


```tsx
render(<Field.Boolean variant="radio" label="Label text" value={false} onChange={value => console.log('onChange', value)} />)
```


#### Radio - Value undefined (no option selected)


```tsx
render(<Field.Boolean variant="radio" label="Label text" onChange={value => console.log('onChange', value)} />)
```


#### Radio - Required


```tsx
render(<Field.Boolean variant="radio" label="Set to be required initially" onChange={value => console.log('onChange', value)} validateInitially required />)
```


#### Radio - With Help


```tsx
render(<Field.Boolean variant="radio" label="Radio variant" help={{
  title: 'Help title',
  content: 'Help content'
}} />)
```


#### Radio - Disabled


```tsx
render(<Field.Boolean variant="radio" label="I am disabled" onChange={value => console.log('onChange', value)} disabled />)
```


#### Radio - Error


```tsx
render(<Field.Boolean variant="radio" label="Label text" onChange={value => console.log('onChange', value)} error={new Error('This is what is wrong...')} />)
```


### Switch

#### Switch - With Help


```tsx
render(<Field.Boolean variant="switch" label="Switch variant" help={{
  title: 'Help title',
  content: 'Help content'
}} />)
```

## Properties

### Field-specific properties


```json
{
  "props": {
    "trueText": {
      "doc": "Text to show in the UI when value is `true`.",
      "type": "string",
      "status": "optional"
    },
    "falseText": {
      "doc": "Text to show in the UI when value is `false`.",
      "type": "string",
      "status": "optional"
    },
    "variant": {
      "doc": "Choice of input feature. Can be: `checkbox`, `switch`, `button`, `checkbox-button` or `buttons`.",
      "type": "string",
      "status": "optional"
    },
    "size": {
      "doc": "The sizes you can choose are `small` (1.5rem), `default` (2rem), `medium` (2.5rem) and `large` (3rem). Defaults to `default` / `null`. Also, if you define a number like `size=\"2\"` then it will be forwarded as the input element attribute. Consider rather setting field sizes with [Form.Appearance](/uilib/extensions/forms/Form/Appearance/).",
      "type": "string",
      "status": "optional"
    }
  }
}
```


### General properties


```json
{
  "props": {
    "value": {
      "doc": "Source data value for the field. Will take precedence over the path value given in the data context.",
      "type": "boolean",
      "status": "optional"
    },
    "defaultValue": {
      "doc": "Default source data value for the field. Will not take precedence over the path value given in the data context.",
      "type": "boolean",
      "status": "optional"
    },
    "path": {
      "doc": "JSON Pointer for where the data for the field is located in the source dataset (when using Form.Handler or DataContext). The `path` will also be set as the `name` attribute for the [string](/uilib/extensions/forms/base-fields/String/)-field.",
      "type": "string",
      "status": "optional"
    },
    "info": {
      "doc": "Info message shown below / after the field by default. Use `statusPosition=\"above\"` to show status messages above the field. When provided as a function, the function will be called with the current value as argument. The second parameter is an object with `{ conditionally, getValueByPath, getFieldByPath }`. To show the message first after the user has interacted with the field, you can call and return `conditionally` function with a callback and with options: `conditionally(() => 'Your message', { showInitially: true })`.",
      "type": [
        "React.ReactNode",
        "Array<React.ReactNode>",
        "function"
      ],
      "status": "optional"
    },
    "warning": {
      "doc": "Warning message shown below / after the field by default. Use `statusPosition=\"above\"` to show status messages above the field. When provided as a function, the function will be called with the current value as argument. The second parameter is an object with `{ conditionally, getValueByPath, getFieldByPath }`. To show the message first after the user has interacted with the field, you can call and return `conditionally` function with a callback and with options: `conditionally(() => 'Your message', { showInitially: true })`.",
      "type": [
        "React.ReactNode",
        "Array<React.ReactNode>",
        "function"
      ],
      "status": "optional"
    },
    "error": {
      "doc": "Error message shown below / after the field. When provided as a function, the function will be called with the current value as argument. The second parameter is an object with `{ conditionally, getValueByPath, getFieldByPath }`. To show the message first after the user has interacted with the field, you can call and return `conditionally` function with a callback and with options: `conditionally(() => 'Your message', { showInitially: true })`.",
      "type": [
        "Error",
        "FormError",
        "Array<Error | FormError>",
        "function"
      ],
      "status": "optional"
    },
    "disabled": {
      "doc": "Set `true` to show the field but without the possibility of changing the value.",
      "type": "boolean",
      "status": "optional"
    },
    "emptyValue": {
      "doc": "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.",
      "type": [
        "boolean",
        "undefined"
      ],
      "status": "optional"
    },
    "required": {
      "doc": "When set to `true`, the field will give an error if the value fails the required validation. When set to `false`, the field will not be required, but will add a \"(optional)\" suffix to the label.",
      "type": "boolean",
      "status": "optional"
    },
    "labelSuffix": {
      "doc": "Will append an additional text to the label, like \"(optional)\". When using `inheritLabel`, the suffix will not be inherited. **NB:** The visual appearance of the `labelSuffix` may change in the future.",
      "type": "React.ReactNode",
      "status": "optional"
    },
    "schema": {
      "doc": "Custom JSON Schema for validating the value.",
      "type": "object",
      "status": "optional"
    },
    "validateInitially": {
      "doc": "Set to `true` to show validation based errors initially (from given value-property or source data) before the user interacts with the field.",
      "type": "boolean",
      "status": "optional"
    },
    "validateUnchanged": {
      "doc": "Set to `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.",
      "type": "boolean",
      "status": "optional"
    },
    "validateContinuously": {
      "doc": "Set to `true` to show validation based errors continuously while writing, not just when blurring the field.",
      "type": "boolean",
      "status": "optional"
    },
    "errorMessages": {
      "doc": "Custom error messages for each type of error, overriding default messages. The messages can be a `React.ReactNode` or a string.",
      "type": "object",
      "status": "optional"
    },
    "onChangeValidator": {
      "doc": "Custom validator function where you can return `undefined`, `Error`, `FormError` or an Array with either several other validators or several `Error` or `FormError`. It is triggered on every change done by the user, and runs during form submit by default. The function can be either asynchronous or synchronous. The first parameter is the value, and the second parameter returns an object containing { errorMessages, connectWithPath, validators }. Use `withValidatorOptions(validator, { runOnSubmit: 'never' })` to keep it from running during form submit, or `'when-changed'` to run it only when the value has changed since the validator last ran. Object and array values are compared by reference.",
      "type": "function",
      "status": "optional"
    },
    "onBlurValidator": {
      "doc": "Custom validator function where you can return `undefined`, `Error`, `FormError` or an Array with either several other validators or several `Error` or `FormError`. It is triggered when the user leaves a field (e.g., blurring a text input or closing a dropdown), and runs during form submit by default. The function can be either asynchronous or synchronous. The first parameter is the value, and the second parameter returns an object containing { errorMessages, connectWithPath, validators }. Use `withValidatorOptions(validator, { runOnSubmit: 'never' })` to keep it from running during form submit, or `'when-changed'` to run it only when the value has changed since the validator last ran. Object and array values are compared by reference.",
      "type": "function",
      "status": "optional"
    },
    "transformIn": {
      "doc": "Transforms the `value` before it's displayed in the field (e.g. input).",
      "type": "function",
      "status": "optional"
    },
    "transformOut": {
      "doc": "Transforms the value before it gets forwarded to the form data object (context) or returned as the `onChange` value parameter. The first parameter is the internal value. Some fields do support a second parameter, like the SelectCountry, where the country object is given.",
      "type": "function",
      "status": "optional"
    },
    "label": {
      "doc": "Label text displayed above the field. Most fields already have a default label, so check the field translations for an existing label entry. Only set `label` when you need to override the default.",
      "type": "string",
      "status": "optional"
    },
    "labelDescription": {
      "doc": "A more discreet text displayed beside the label (e.g. \"(optional)\").",
      "type": "string",
      "status": "optional"
    },
    "labelDescriptionInline": {
      "doc": "If `true`, the `labelDescription` will be displayed on the same line as the label.",
      "type": "boolean",
      "status": "optional"
    },
    "labelSrOnly": {
      "doc": "Use `true` to make the label only readable by screen readers.",
      "type": "boolean",
      "status": "optional"
    },
    "labelSize": {
      "doc": "Define the font-size of the label based on the [font-size](/uilib/typography/font-size/) table.",
      "type": [
        "\"medium\"",
        "\"large\""
      ],
      "status": "optional"
    },
    "help": {
      "doc": "Provide help content for the field using `title` and `content` as a string or `React.ReactNode`. Additionally, you can set `open` to `true` to display the inline help, set the `breakout` property to `false` to disable the breakout of the inline help content, set `outset` to `false` to display the help text inline (inset) instead of the default outset behavior, or use `renderAs` set to `dialog` to render the content in a [Dialog](/uilib/components/dialog/) (recommended for larger amounts of content).",
      "type": "object",
      "status": "optional"
    },
    "hideHelpButton": {
      "doc": "Set `true` when you render the inline help button outside the label (e.g. inside a checkbox suffix) so FieldBlock skips drawing the default label help button.",
      "type": "boolean",
      "status": "optional"
    },
    "statusPosition": {
      "doc": "Controls where status messages (`error`, `warning`, `information`) are visually shown. Use `below` (default) or `above`.",
      "type": [
        "\"below\"",
        "\"above\""
      ],
      "status": "optional"
    },
    "layout": {
      "doc": "Layout for the label and input. Can be `horizontal` or `vertical`.",
      "type": [
        "\"horizontal\"",
        "\"vertical\""
      ],
      "status": "optional"
    },
    "layoutOptions": {
      "doc": "Use this to set additional options for the `horizontal` layout, e.g. `{ width: \"medium\" }`. You can also use a custom width `{number}rem`. Instead of a width, you can use a min/max width, e.g. `{ minWidth: \"6rem\", maxWidth: \"12rem\" }`.",
      "type": "object",
      "status": "optional"
    },
    "width": {
      "doc": "Will set the width for the whole block. Use `small`, `medium`, `large` for predefined standard widths. You can also set a custom width `{number}rem` or use `stretch` or `false`.",
      "type": [
        "string",
        "false"
      ],
      "status": "optional"
    },
    "contentWidth": {
      "doc": "Will set the width for its contents. Use `small`, `medium`, `large` for predefined standard widths. You can also set a custom width `{number}rem` or use `stretch` or `false`.",
      "type": [
        "string",
        "false"
      ],
      "status": "optional"
    },
    "[Space](/uilib/layout/space/properties)": {
      "doc": "Spacing properties like `top` or `bottom` are supported.",
      "type": [
        "string",
        "object"
      ],
      "status": "optional"
    }
  },
  "valueType": "boolean",
  "omit": [
    "layout",
    "layoutOptions"
  ]
}
```


## Translations


```json
{
  "locales": [
    "da-DK",
    "en-GB",
    "nb-NO",
    "sv-SE"
  ],
  "entries": {
    "BooleanField.no": {
      "nb-NO": "Nei",
      "en-GB": "No",
      "sv-SE": "Nej",
      "da-DK": "Nej"
    },
    "BooleanField.yes": {
      "nb-NO": "Ja",
      "en-GB": "Yes",
      "sv-SE": "Ja",
      "da-DK": "Ja"
    },
    "Field.errorPattern": {
      "nb-NO": "Du må skrive inn en gyldig verdi.",
      "en-GB": "You must enter a valid value.",
      "sv-SE": "Du måste ange ett giltigt värde.",
      "da-DK": "Du skal indtaste en gyldig værdi."
    },
    "Field.errorRequired": {
      "nb-NO": "Dette feltet må fylles ut.",
      "en-GB": "This field is required.",
      "sv-SE": "Detta fält måste fyllas i.",
      "da-DK": "Dette felt skal udfyldes."
    },
    "Field.errorSummary": {
      "nb-NO": "Feil som må rettes:",
      "en-GB": "Please correct the following errors:",
      "sv-SE": "Fel som måste åtgärdas:",
      "da-DK": "Felter der skal rettes:"
    },
    "Field.errorSummaryTitle": {
      "nb-NO": "Feil som må rettes",
      "en-GB": "Please correct the following errors",
      "sv-SE": "Fel som måste åtgärdas",
      "da-DK": "Felter der skal rettes"
    },
    "Field.optionalLabelSuffix": {
      "nb-NO": "(valgfritt)",
      "en-GB": "(optional)",
      "sv-SE": "(valfritt)",
      "da-DK": "(valgfrit)"
    },
    "Field.stateSummary": {
      "nb-NO": "Oppsummering:",
      "en-GB": "Summary:",
      "sv-SE": "Sammanfattning:",
      "da-DK": "Oversigt:"
    }
  }
}
```

## Events

### Field-specific events


```json
{
  "props": {
    "onClick": {
      "doc": "Will be called on click.",
      "type": "(value: unknown, { event: ClickEvent, preventDefault: () => void }) => void",
      "status": "optional"
    }
  }
}
```


### General events


```json
{
  "props": {
    "onChange": {
      "doc": "Will be called on value changes made by the user, with the new value as argument. When an `async` function is used, the corresponding [FieldBlock](/uilib/extensions/forms/create-component/FieldBlock/) will show an indicator on the field label. You can return `{ success: 'saved' } as const` to show a success symbol, or an error or an object with these keys `{ info: 'Info message', warning: 'Warning message', error: Error('My error') } as const`. The second parameter is an object that e.g. contains `properties` (all given `Field.*` properties).",
      "type": "(value) => void",
      "status": "optional"
    },
    "onFocus": {
      "doc": "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. The second parameter is an object that e.g. contains `properties` (all given `Field.*` properties).",
      "type": "(value) => void",
      "status": "optional"
    },
    "onBlur": {
      "doc": "Will be called when the component stops being in focus. Like when going to next field, or closing a dropdown. Called with active value as argument. The second parameter is an object that e.g. contains `properties` (all given `Field.*` properties).",
      "type": "(value) => void",
      "status": "optional"
    },
    "onStatusChange": {
      "doc": "Called whenever the status messages (info, warning or error) gets visible or changes. Receives the current `{ info, warning, error }` object.",
      "type": "({ info?, warning?, error? }: FieldStatus) => void",
      "status": "optional"
    }
  }
}
```