sp-checkbox

Since: UXP v4.1

Renders a checkbox with associated label.

See:

• https://spectrum.adobe.com/page/checkbox/
• https://opensource.adobe.com/spectrum-web-components/components/checkbox

Example

Copy
<sp-checkbox>Include all metadata</sp-checkbox>
Copied to your clipboard
<sp-checkbox>Include all metadata</sp-checkbox>

States

There are several states that are supported.

Checked

Copy
<sp-checkbox checked>Checked</sp-checkbox>
Copied to your clipboard
<sp-checkbox checked>Checked</sp-checkbox>

Indeterminate

Copy
<sp-checkbox indeterminate>Indeterminate</sp-checkbox>
Copied to your clipboard
<sp-checkbox indeterminate>Indeterminate</sp-checkbox>

Disabled

Copy
<sp-checkbox disabled>Disabled</sp-checkbox>
Copied to your clipboard
<sp-checkbox disabled>Disabled</sp-checkbox>

Invalid

Copy
<sp-checkbox invalid>Invalid</sp-checkbox>
Copied to your clipboard
<sp-checkbox invalid>Invalid</sp-checkbox>

Responding to events

You can respond to changes in the checkbox using the change or input events.

Copy
document.querySelector(".yourCheckbox").addEventListener("change", evt => {
    console.log(`Is the checkbox checked: ${evt.target.checked}`);
})
Copied to your clipboard
document.querySelector(".yourCheckbox").addEventListener("change", evt => {
    console.log(`Is the checkbox checked: ${evt.target.checked}`);
})