---
title: "Checkbox"
description: "The Checkbox Component."
canonical_url: "https://docs.ctrl-neo.dev/en/owo-ui-components/components/checkbox"
---
# Checkbox

> The Checkbox Component.

The checkbox component represents a toggleable checkbox. It can display text alongside the checkbox.

## Parameters

<field-group>
<field name="text" type="string">

The text to display next to the checkbox.

</field>

<field name="checked" type="boolean">

Whether the checkbox is checked or not.

</field>

<field name="active" type="boolean">

Whether the checkbox is active or not.

</field>
</field-group>

## Examples

<code-group>

```java [Checkbox.java]
Components.checkbox(Text.literal("Option"), true)
    .active(false)
```

```xml [checkbox.xml]
<checkbox>
    <text>Option</text>
    <checked>true</checked>
    <active>false</active>
</checkbox>
```

</code-group>


## Sitemap

See the full [sitemap](https://docs.ctrl-neo.dev/sitemap.md) for all pages.