# Checkbox input

## Availability

\[SINCE Orbeon Forms 2016.1]

## What it does

The `fr:checkbox-input` component displays a single checkbox and by default stores a value of `true` when selected and `false` when deselected.

<figure><img src="/files/-LEkC7Fj2bphKrKuP-Tr" alt="" width="133"><figcaption></figcaption></figure>

*NOTE: It differs from the (deprecated in Orbeon Forms 2016.1) Boolean Input field (obtained by binding an `xf:input` to a field of `xs:boolean` type) in that the Checkbox Input displays the label right next to the checkbox.*

![Appearance](/files/-LEkC7Fpauu2iajiX2WU)

## Basic usage

You use `fr:checkbox-input` like a regular XForms controls. Example:

```xml
<fr:checkbox-input ref="initially-open">
    <xf:label>Initially Open</xf:label>
</fr:checkbox-input>
```

## Advanced usage

The datatype of the bound node is typically `xs:boolean` but doesn't have to.

The following attributes can be passed:

* `selected-value`: value to store when the checkbox is selected, by default `true`
* `deselected-value`: value to store when the checkbox is deselected, by default `false`

Example:

```xml
<fr:checkbox-input
    ref="whitespace"
    selected-value="trim"
    deselected-value="">
    <xf:label>Trim leading and trailing spaces</xf:label>
</fr:checkbox-input>
```

The control works like `xf:select` in that it adds and removes the selected value (by default `true`) into a space-separated list of tokens without affecting other tokens. With the following example, say the bound node initially contains:

```xml
<whitespace>foo bar</whitespace>
```

When the user selects the checkbox. The node now contains:

```xml
<whitespace>foo bar trim</whitespace>
```

And when the user deselects the checkbox. The node contains again:

```xml
<whitespace>foo bar</whitespace>
```

*NOTE: The control only store a value into the bound node when the user changes the checkbox selection. Say the data by default is blank: the control will not automatically change it to `false` (or to the value set by `deselected-value`) until the user selects then deselects the value again.*

## See also

* [Yes/No Answer Component](/form-runner/component/yesno-input.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.orbeon.com/form-runner/component/checkbox-input.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.