摘要
<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
元素配对,以确保它具有无障碍名称。
参考
演示
用法示例
<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') 或调用新的 HowToCheckbox() 来创建实例。构造函数是创建 shadow DOM 的好位置,尽管您应该避免触摸任何属性或 light DOM 子项,因为它们可能尚不可用。
constructor() {
super();
this.attachShadow({mode: 'open'});
this.shadowRoot.appendChild(template.content.cloneNode(true));
}
connectedCallback()
会在元素插入 DOM 时触发。非常适合设置初始 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;
}
}
disconnectedCallback()
会在元素从 DOM 中移除时触发。它非常适合用于执行清理工作,例如释放引用和移除事件监听器。
disconnectedCallback() {
this.removeEventListener('keyup', this._onKeyUp);
this.removeEventListener('click', this._onClick);
}
属性及其对应的属性应相互镜像。检查的属性 setter 会处理 真的/falsy 值,并将这些值反映到属性的状态。如需了解详情,请参阅避免重入部分。
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');
}
当 observeAttributes 数组中的任何属性发生更改时,系统会调用 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()
会调用选中的 setter 并翻转其状态。由于 _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);
})();