Porsche Design System

Checkbox

Table of Contents

Form
Indeterminate
Slots

Form#

The p-checkbox can be integrated into a form in two ways: controlled or uncontrolled, depending on your needs.

In the controlled approach, the checkbox state is externally managed using the checked property and change event to keep it in sync with your application logic. This approach is ideal for complex forms or when using a form library. Note that the component will still always update its internal value automatically when interacted with.

In the uncontrolled approach, the checkbox behaves similar to a native <input type="checkbox" />, automatically managing its own state and including its value in form submissions through the ElementInternals API. This is convenient for smaller forms or simple submissions.

For more details on form integration, refer to the Form section in the developing documentation for your framework of choice, or find a full form integration example in our examples repository.

Open in Stackblitz

<!doctype html>
<html lang="en" class="auto">
<head>
  <title></title>
</head>
<body class="bg-canvas">

<form class="flex flex-col gap-fluid-sm">
  <p-checkbox name="myCheckbox" label="Some Label"></p-checkbox>
  <div class="flex gap-fluid-sm">
    <p-button type="submit">Submit</p-button>
    <p-button type="reset">Reset</p-button>
  </div>
  <p-text>Last submitted data: </p-text>
</form>
<script>
  const debugElement = document.querySelector('p-text');
  const form = document.querySelector('form');
  form.addEventListener('submit', (e) => {
    e.preventDefault();
    const formData = new FormData(form);
    debugElement.innerText = `Last submitted data: ${formData.get('myCheckbox')}`;
  });
</script>
</body>
</html>

Indeterminate#

Mask the visual appearance of a checkbox which has a state in-between checked and unchecked. This is especially useful for a checkbox that is used to set the state of a group of checkboxes at once. However, this group might have a mixed state. In this case we recommend to use checked=false and indeterminate=true.

Note: The indeterminate attribute only affects how the checkbox is shown. The current value is hidden from the user, but the checkbox still keeps it's checked state. You can find more details in the specification.

Open in Stackblitz

<!doctype html>
<html lang="en" class="auto">
<head>
  <title></title>
</head>
<body class="bg-canvas">

<p-checkbox label="Some label" indeterminate="true"></p-checkbox>

<p-checkbox label="Some label" indeterminate="true" checked="true"></p-checkbox>
<script>

</script>
</body>
</html>

Slots#

Sometimes it's useful to be able to render markup (e.g. an anchor tag) for label or message. Therefore, a named slot can be used. Make sure not to define the corresponding property on the host element when a named slot is used (because a property definition is preferred over a named slot). For named slots only phrasing content is allowed.

Some label with a linkSome error message with a link

Open in Stackblitz

<!doctype html>
<html lang="en" class="auto">
<head>
  <title></title>
</head>
<body class="bg-canvas">

<p-checkbox state="error" name="some-name" aria-labelledby="some-label-id" aria-describedby="some-message-id">
  <span slot="label" id="some-label-id">
    Some label with a 
    <a href="https://designsystem.porsche.com">
      link
    </a>
  </span>
  <span slot="message" id="some-message-id">
    Some error message with a 
    <a href="https://designsystem.porsche.com">
      link
    </a>
  </span>
</p-checkbox>
<script>

</script>
</body>
</html>