CheckboxGroup

A configurable CheckboxGroup component used as a container of Checkbox elements.

Import

React

// with @dhl-official/react-library:
import { DhlCheckboxGroupGroup } from "@dhl-official/react-library"

// with @dhl-official/ui-libraries/react-library:
import { DhlCheckboxGroupGroup } from "@dhl-official/ui-libraries/react-library"

Angular

If the DUIL has been installed, you can use the web component directly:

<dhl-checkbox-group-group></dhl-checkbox-group-group>

Vue.js

// with @dhl-official/vue-library:
import { DhlCheckboxGroupGroup } from "@dhl-official/vue-library"

// with @dhl-official/ui-libraries/vue-library:
import { DhlCheckboxGroupGroup } from "@dhl-official/ui-libraries/vue-library"

Code

React

<DhlCheckboxGroup>
  [dhl-checkbox elements]
</DhlCheckboxGroup>

Angular

<dhl-checkbox-group>
  [dhl-checkbox elements]
</dhl-checkbox-group>

Vue.js

<dhl-checkbox-group>
  [dhl-checkbox elements]
</dhl-checkbox-group>

Interactive Demo

Readme

Usage

Dhl-checkbox-group

Snippets of code in HTML and JavaScript to show some of the use cases for the component. The code is not meant to be executed, but to be used as a reference for the usage of the component.
Angular, React and Vue usages are not included in this documentation, but can be easily derived from the HTML and JavaScript code.

default usage

<form novalidate>
  <dhl-checkbox-group 
    label="Checkbox Group"
    name="checkbox-group">
    <dhl-checkbox
      name="checkbox-1"
      value="value1"
      >Checkbox 1</dhl-checkbox
    >
    <dhl-checkbox
      name="checkbox-2"
      value="value2"
      >Checkbox 2</dhl-checkbox
    >
    <dhl-checkbox
      name="checkbox-3"
      value="value3"
      >Checkbox 3</dhl-checkbox
    >
  </dhl-checkbox-group>


  <dhl-button
    type="reset"
    variant="outline"
    >reset</dhl-button
  >
  <dhl-button type="submit">submit</dhl-button>
</form>

<script>
  const form = document.querySelector("form");
  form.addEventListener("submit", async (e) => {
    e.preventDefault();
    console.log(Object.fromEntries(new FormData(form)));
    return await e.target.checkValidity();
  });
</script>

usage with validation (required) and (browser) default validation message

<form novalidate>
  <dhl-checkbox-group
    name="checkbox-group"
    label="Checkbox Group"
    required
  >
    <dhl-checkbox
      name="checkbox-1"
      value="value1"
      >Checkbox 1</dhl-checkbox
    >
    <dhl-checkbox
      name="checkbox-2"
      value="value2"
      >Checkbox 2</dhl-checkbox
    >
    <dhl-checkbox
      name="checkbox-3"
      value="value3"
      >Checkbox 3</dhl-checkbox
    >
  </dhl-checkbox-group>

  <dhl-button
    type="reset"
    variant="outline"
    >reset</dhl-button
  >
  <dhl-button type="submit">submit</dhl-button>
</form>

<script>
  const form = document.querySelector("form");
  form.addEventListener("submit", async (e) => {
    e.preventDefault();
    console.log(Object.fromEntries(new FormData(form)));
    await e.target.checkValidity();
  });
</script>

usage with validation (required) and custom validation message

<form novalidate>
  <dhl-checkbox-group
    label="Checkbox Group"
    name="checkbox-group"
    required
  >
    <dhl-checkbox
    name="checkbox-1"
    value="value1"
    required
    >Checkbox 1</dhl-checkbox
  >
  <dhl-checkbox
    name="checkbox-2"
    value="value2"
    required="true"
    >Checkbox 2</dhl-checkbox
  >
  <dhl-checkbox
    name="checkbox-3"
    value="value3"
    required="false"
    >Checkbox 3</dhl-checkbox
  >
  </dhl-checkbox-group>

  <dhl-button
    type="reset"
    variant="outline"
    >reset</dhl-button
  >
  <dhl-button type="submit">submit</dhl-button>
</form>

<script>
  const form = document.querySelector("form");
  const checkboxGroup = document.querySelector("dhl-checkbox-group");
  const validationMessageInvalid = "This field is required";
  const validationMessageValid = "This field is valid";

  form.addEventListener("submit", async (e) => {
    e.preventDefault();
    const isValid = await e.target.checkValidity();
    const elementValid = await checkboxGroup.checkValidity();

    checkboxGroup.validation = {
      type: elementValid ? Variants.valid : Variants.invalid,
      message: elementValid ? validationMessageValid : validationMessageInvalid,
    };
    return isValid;
  });
</script>

usage with custom events

<form novalidate>
  <dhl-checkbox-group
    label="Checkbox Group"
    name="checkbox-group"
    data-orientation="vertical"
    required
  >
    <dhl-checkbox
      name="checkbox-1"
      value="value1"
      >Checkbox 1</dhl-checkbox
    >
    <dhl-checkbox
      name="checkbox-2"
      value="value2"
      >Checkbox 2</dhl-checkbox
    >
    <dhl-checkbox
      name="checkbox-3"
      value="value3"
      >Checkbox 3</dhl-checkbox
    >
  </dhl-checkbox-group>

  <dhl-button
    type="reset"
    variant="outline"
    >reset</dhl-button
  >
  <dhl-button type="submit">submit</dhl-button>
</form>

<script>
  const form = document.querySelector("form");
  const checkboxGroup = document.querySelector("dhl-checkbox-group");

  checkboxGroup.addEventListener("dhlChange", async (e) => {
    const isValid = await e.target.checkValidity();
    console.log(e.target, "is valid:", isValid);
    return isValid;
  });
</script>

Properties

Property	Attribute	Description	Type	Default
dataAriaLabel	data-aria-label	An optional prop defining the text read by the screen reader to represent the component; use this if you need different text to be read from label.	string	undefined
dataClassName	data-class-name	An optional class name prop for the component.	string	undefined
dataId	data-id	An optional prop. Gives a valid HTML ID attribute value for the component.	string	dhl-checkbox-group-${getRandomString()}
dataOrientation	data-orientation	An optional prop to determine the layout of the component. It takes any valid value that can be used for the class attribute of an HTMLInputElement.	Orientation.horizontal \| Orientation.vertical	DHL_CHECKBOX_GROUP.ORIENTATION.HORIZONTAL
dataTestid	data-testid	An optional prop. The test id attached to the component as a data-testid attribute.	string	undefined
isDisabled	disabled	An optional flag to define if the component is disabled.	boolean	undefined
label	label	An optional label for the component.	string	undefined
name	name	An optional value to be set to the element HTML name attribute. It takes any valid value that can be used for the name attribute of an HTMLInputElement.	string	dhl-checkbox-group-${getRandomString()}
required	required	An optional prop to flag the component as required within a form context.	boolean	undefined
validation	--	An optional object to set-up a custom components validation state. Required Fields: type	{ type: Variants.warning \| Variants.valid \| Variants.invalid \| Variants.note; message?: string; }	undefined
value	value	An optional prop defining the value of the component which is taken when a form is submitted.	string	""

Slots

Slot	Description
"unnamed"	unnamed children slot for text that accompanies the DhlCheckbox

Dependencies

Depends on

• dhl-selection-control-group

Graph

---

Built by DHL User Interface Library Team!