HowTo 组件 - howto 复选框

Ewa Gasperowicz
X
Rob Dodson
Surma

摘要

<howto-checkbox> 表示表单中的布尔值选项。最常见的复选框类型是双重类型，可让用户在两种选择（已选中和未选中）之间切换。

该元素在首次创建时会尝试自行应用属性 role="checkbox" 和 tabindex="0"。role 属性可帮助屏幕阅读器等辅助技术向用户指明这是哪种控件。tabindex 属性可将元素纳入 Tab 键顺序，使其可通过键盘获得焦点并可操作。如需详细了解这两个主题，请参阅 ARIA 有何用途和使用 tabindex。

当复选框处于选中状态时，它会添加 checked 布尔属性，并将相应的 checked 属性设置为 true。此外，该元素会将 aria-checked 属性设为 "true" 或 "false"，具体取决于其状态。使用鼠标或空格键点击复选框可切换这些已选状态。

复选框还支持 disabled 状态。如果 disabled 属性设置为 true 或应用了 disabled 属性，则复选框会设置 aria-disabled="true"、移除 tabindex 属性，并将焦点返回到文档（如果复选框是当前的 activeElement）。

复选框与 howto-label 元素搭配使用，以确保其具有无障碍名称。

参考

演示

在 GitHub 上查看实时演示

用法示例

<style>
  howto-checkbox {
    vertical-align: middle;
  }
  howto-label {
    vertical-align: middle;
    display: inline-block;
    font-weight: bold;
    font-family: sans-serif;
    font-size: 20px;
    margin-left: 8px;
  }
</style>

<howto-checkbox id="join-checkbox"></howto-checkbox>
<howto-label for="join-checkbox">Join Newsletter</howto-label>

代码

(function() {

定义键代码，以便处理键盘事件。

  const KEYCODE = {
    SPACE: 32,
  };

从 <template> 元素克隆内容的性能高于使用 innerHTML，因为它可以避免额外的 HTML 解析开销。

  const template = document.createElement('template');

  template.innerHTML = `
    <style>
      :host {
        display: inline-block;
        background: url('../images/unchecked-checkbox.svg') no-repeat;
        background-size: contain;
        width: 24px;
        height: 24px;
      }
      :host([hidden]) {
        display: none;
      }
      :host([checked]) {
        background: url('../images/checked-checkbox.svg') no-repeat;
        background-size: contain;
      }
      :host([disabled]) {
        background:
          url('../images/unchecked-checkbox-disabled.svg') no-repeat;
        background-size: contain;
      }
      :host([checked][disabled]) {
        background:
          url('../images/checked-checkbox-disabled.svg') no-repeat;
        background-size: contain;
      }
    </style>
  `;


  class HowToCheckbox extends HTMLElement {
    static get observedAttributes() {
      return ['checked', 'disabled'];
    }

每当创建新实例时，系统都会运行元素的构造函数。实例的创建方式包括解析 HTML、调用 document.createElement('howto-checkbox') 或调用 new HowToCheckbox(); 构造函数是创建 shadow DOM 的好地方，但您应避免触及任何属性或轻量 DOM 子项，因为它们可能尚不可用。

    constructor() {
      super();
      this.attachShadow({mode: 'open'});
      this.shadowRoot.appendChild(template.content.cloneNode(true));
    }

当元素插入 DOM 时，connectedCallback() 会触发。这是设置初始 role、tabindex、内部状态以及安装事件监听器的好地方。

    connectedCallback() {
      if (!this.hasAttribute('role'))
        this.setAttribute('role', 'checkbox');
      if (!this.hasAttribute('tabindex'))
        this.setAttribute('tabindex', 0);

用户可以在元素的原型连接到此类之前，对元素的实例设置属性。_upgradeProperty() 方法会检查是否存在任何实例属性，并通过适当的类 setter 运行这些属性。如需了解详情，请参阅延迟属性部分。

      this._upgradeProperty('checked');
      this._upgradeProperty('disabled');

      this.addEventListener('keyup', this._onKeyUp);
      this.addEventListener('click', this._onClick);
    }

    _upgradeProperty(prop) {
      if (this.hasOwnProperty(prop)) {
        let value = this[prop];
        delete this[prop];
        this[prop] = value;
      }
    }

当元素从 DOM 中移除时，disconnectedCallback() 会触发。此时非常适合执行清理工作，例如释放引用和移除事件监听器。

    disconnectedCallback() {
      this.removeEventListener('keyup', this._onKeyUp);
      this.removeEventListener('click', this._onClick);
    }

房源及其对应的属性应相互反映。checked 的属性设置器会处理真值/假值，并将这些值反映到属性的状态。如需了解详情，请参阅避免重入部分。

    set checked(value) {
      const isChecked = Boolean(value);
      if (isChecked)
        this.setAttribute('checked', '');
      else
        this.removeAttribute('checked');
    }

    get checked() {
      return this.hasAttribute('checked');
    }

    set disabled(value) {
      const isDisabled = Boolean(value);
      if (isDisabled)
        this.setAttribute('disabled', '');
      else
        this.removeAttribute('disabled');
    }

    get disabled() {
      return this.hasAttribute('disabled');
    }

当 observedAttributes 数组中的任何属性发生更改时，系统都会调用 attributeChangedCallback()。它是处理副作用（例如设置 ARIA 属性）的好地方。

    attributeChangedCallback(name, oldValue, newValue) {
      const hasValue = newValue !== null;
      switch (name) {
        case 'checked':
          this.setAttribute('aria-checked', hasValue);
          break;
        case 'disabled':
          this.setAttribute('aria-disabled', hasValue);

tabindex 属性无法完全移除元素的可聚焦性。您仍然可以使用鼠标或调用 focus() 来聚焦具有 tabindex=-1 的元素。如需确保元素处于停用状态且不可聚焦，请移除 tabindex 属性。

          if (hasValue) {
            this.removeAttribute('tabindex');

如果焦点当前位于此元素上，请调用 HTMLElement.blur() 方法取消焦点

            this.blur();
          } else {
            this.setAttribute('tabindex', '0');
          }
          break;
      }
    }

    _onKeyUp(event) {

请勿处理辅助技术通常使用的修饰符快捷键。

      if (event.altKey)
        return;

      switch (event.keyCode) {
        case KEYCODE.SPACE:
          event.preventDefault();
          this._toggleChecked();
          break;

系统会忽略任何其他按键操作，并将其传回给浏览器。

        default:
          return;
      }
    }

    _onClick(event) {
      this._toggleChecked();
    }

_toggleChecked() 会调用已选设置器并翻转其状态。由于 _toggleChecked() 仅由用户操作触发，因此它还会分派更改事件。此事件会向上冒泡，以模仿 <input type=checkbox> 的原生行为。

    _toggleChecked() {
      if (this.disabled)
        return;
      this.checked = !this.checked;
      this.dispatchEvent(new CustomEvent('change', {
        detail: {
          checked: this.checked,
        },
        bubbles: true,
      }));
    }
  }

  customElements.define('howto-checkbox', HowToCheckbox);
})();