Checkbox

checkbox

Checkboxes are composed using a set of <span> elements alongside the native <input type="cehckbox"> element which should be given the checkbox__native class and come before the remaining presentational <span> elements.

<span class="checkbox">
  <input type="checkbox" class="checkbox__native">
  <span class="checkbox__background">
    <span class="checkbox__box">
      <span class="checkbox__icon"></span>
    </span>
  </span>
</span>

import Checkbox from "@vrembem/checkbox";
const checkbox = new Checkbox({ autoInit: true });

checkbox + label

For checkboxes with labels, just wrap the checkbox component along with label text using the <label> element.

<label>
  <span class="checkbox">
    <input type="checkbox" class="checkbox__native">
    <span class="checkbox__background">
      <span class="checkbox__box">
        <span class="checkbox__icon"></span>
      </span>
    </span>
  </span>
  Checkbox with a label
</label>

checkbox_size_[value]

Adjust the size of a checkbox by increasing or decreasing its width and height. By default, the checkbox scale will provide a checkbox height of 30px (small checkbox_size_sm), 40px (default) and 50px (large checkbox_size_lg).

<span class="checkbox checkbox_size_sm">
  ...
</span>

<span class="checkbox checkbox_size_lg">
  ...
</span>

Available Variations

• checkbox_size_sm
• checkbox_size_lg

Sass variables

JavaScript Options

Sass Functions

@function icon-check($size, $color, $stroke)

Outputs data image string for check SVG icon. Used as the value of url() in background-image property.

Arguments

Example

.icon-check {
  background-image: url(icon-check(18px, #fff, 2));
}

// CSS Output
.icon-check {
  background-image: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="18px" height="18px" fill="none" stroke="%23FFFFFF" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="9.5,3 4.5,8.5 2,6"></polyline></svg>');
}

@function icon-minus($size, $color, $stroke)

Outputs data image string for minus SVG icon. Used as the value of url() in background-image property.

Arguments

Example

.icon-minus {
  background-image: url(icon-minus(18px, #fff, 2));
}

// CSS Output
.icon-minus {
  background-image: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="18px" height="18px" fill="none" stroke="%23FFFFFF" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="2" y1="6" x2="10" y2="6" /></svg>');
}

API

checkbox.init(options)

Initializes the checkbox instance. During initialization, the following processes are run:

• Sets checkboxes to the indeterminate state that match the provided attribute and values.
• Attaches the click event listener that handles switching off the indeterminate state.

Parameters

• options [Object] (optional) An options object for passing your custom settings.

const checkbox = new Checkbox();
checkbox.init();

checkbox.destroy()

Destroys and cleans up the checkbox instantiation. For the checkbox component, this just involves removing the click event listener.

const checkbox = new Checkbox();
checkbox.init();
// ...
checkbox.destroy();

checkbox.setAriaState(el, value)

Sets the aria attribute value for mixed checkboxes.

Parameters

• el The element or elements whose aria state should be set.
• value (Default: settings.stateValue) The value that should be set to the aria attribute.

Example removes presentational <span> elements for brevity but should be included in your implementation.

<!-- Initial HTML -->
<input type="checkbox" class="checkbox__native">
<input type="checkbox" class="checkbox__native">
<input type="checkbox" class="checkbox__native">

const els = document.querySelectorAll('.checkbox__native');
checkbox.setAriaState(els);

<!-- Result -->
<input type="checkbox" class="checkbox__native" aria-checked="mixed">
<input type="checkbox" class="checkbox__native" aria-checked="mixed">
<input type="checkbox" class="checkbox__native" aria-checked="mixed">

checkbox.removeAriaState(el)

Removes the aria attribute value for mixed checkboxes.

Parameters

• el The element or elements whose aria state should be removed.

Example removes presentational <span> elements for brevity but should be included in your implementation.

<!-- Initial HTML -->
<input type="checkbox" class="checkbox__native" aria-checked="mixed">
<input type="checkbox" class="checkbox__native" aria-checked="mixed">
<input type="checkbox" class="checkbox__native" aria-checked="mixed">

const els = document.querySelectorAll('.checkbox__native');
checkbox.removeAriaState(els);

<!-- Result -->
<input type="checkbox" class="checkbox__native">
<input type="checkbox" class="checkbox__native">
<input type="checkbox" class="checkbox__native">

checkbox.setIndeterminate(el)

Sets the indeterminate state of a checkbox based on whether or not the aria-checkbox attribute is set to "mixed" if using the default settings.

Parameters

• el The element or elements whose indeterminate state should be set.

const els = document.querySelectorAll('.checkbox__native');
checkbox.setIndeterminate(els);

To learn more about the indeterminate state, click here. It’s important to note that this state is set using the HTMLInputElement object’s indeterminate property via JavaScript (it cannot be set using an HTML attribute).