Skip to content
Version:

Install

Maven

xml
<dependency>
    <groupId>com.vaadin</groupId>
    <artifactId>vaadin-checkbox-flow</artifactId>
</dependency>

Import

java
import com.vaadin.flow.component.checkbox.Checkbox;
import com.vaadin.flow.component.checkbox.CheckboxGroup;

Variants

Default

java
Checkbox checkbox = new Checkbox("Default");

Checked

java
Checkbox checkbox = new Checkbox("Checked");
checkbox.getElement().setProperty("checked", true);

Indeterminate

java
Checkbox checkbox = new Checkbox("Indeterminate");
checkbox.setIndeterminate(true);

Disabled

java
Checkbox checkbox = new Checkbox("Disabled");
checkbox.setEnabled(false);

Disabled Checked

java
Checkbox checkbox = new Checkbox("Disabled checked");
checkbox.getElement().setProperty("checked", true);
checkbox.setEnabled(false);

Checkbox Group

java
CheckboxGroup<String> checkboxGroup = new CheckboxGroup<>();
checkboxGroup.setLabel("Group");
checkboxGroup.setItems("Item 1", "Item 2", "Item 3");
checkboxGroup.select("Item 1");

Vertical Group

java
CheckboxGroup<String> checkboxGroup = new CheckboxGroup<>();
checkboxGroup.addThemeVariants(CheckboxGroupVariant.LUMO_VERTICAL);
checkboxGroup.setLabel("Group");
checkboxGroup.setItems("Item 1", "Item 2", "Item 3");
checkboxGroup.select("Item 1");