2021-09-24 21:31:43 +03:00
|
|
|
/**
|
|
|
|
* @license
|
|
|
|
* Copyright 2021 Google LLC
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
*/
|
|
|
|
|
2022-10-18 19:28:12 +03:00
|
|
|
import '../../focus/focus-ring.js';
|
|
|
|
import '../../ripple/ripple.js';
|
2021-09-24 21:31:43 +03:00
|
|
|
|
2023-05-17 03:57:49 +03:00
|
|
|
import {html, isServer, LitElement, nothing, PropertyValues, TemplateResult} from 'lit';
|
2023-05-26 20:05:54 +03:00
|
|
|
import {property, query} from 'lit/decorators.js';
|
2022-08-24 21:00:50 +03:00
|
|
|
import {ClassInfo, classMap} from 'lit/directives/class-map.js';
|
2021-12-17 00:36:39 +03:00
|
|
|
|
2023-05-30 20:37:05 +03:00
|
|
|
import {requestUpdateOnAriaChange} from '../../internal/aria/delegate.js';
|
2023-05-31 05:42:34 +03:00
|
|
|
import {dispatchActivationClick, isActivationClick} from '../../internal/controller/events.js';
|
2022-10-18 19:28:12 +03:00
|
|
|
|
2022-12-15 03:49:11 +03:00
|
|
|
/**
|
|
|
|
* @fires input {InputEvent} Fired whenever `selected` changes due to user
|
|
|
|
* interaction (bubbles and composed).
|
|
|
|
* @fires change {Event} Fired whenever `selected` changes due to user
|
|
|
|
* interaction (bubbles).
|
|
|
|
*/
|
2022-12-20 01:03:21 +03:00
|
|
|
export class Switch extends LitElement {
|
2023-04-25 00:10:06 +03:00
|
|
|
static {
|
|
|
|
requestUpdateOnAriaChange(this);
|
|
|
|
}
|
|
|
|
|
2021-12-29 20:45:59 +03:00
|
|
|
static override shadowRootOptions:
|
|
|
|
ShadowRootInit = {mode: 'open', delegatesFocus: true};
|
|
|
|
|
2023-06-05 21:34:12 +03:00
|
|
|
/** @nocollapse */
|
2023-05-30 23:34:24 +03:00
|
|
|
static formAssociated = true;
|
2022-12-17 04:06:12 +03:00
|
|
|
|
2022-12-13 06:01:29 +03:00
|
|
|
/**
|
|
|
|
* Disables the switch and makes it non-interactive.
|
|
|
|
*/
|
2021-12-29 20:45:59 +03:00
|
|
|
@property({type: Boolean, reflect: true}) disabled = false;
|
2022-12-13 06:01:29 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Puts the switch in the selected state and sets the form submission value to
|
|
|
|
* the `value` property.
|
|
|
|
*/
|
2021-09-24 21:31:43 +03:00
|
|
|
@property({type: Boolean}) selected = false;
|
2022-12-13 06:01:29 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Shows both the selected and deselected icons.
|
|
|
|
*/
|
2022-04-29 21:43:31 +03:00
|
|
|
@property({type: Boolean}) icons = false;
|
2022-12-13 06:01:29 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Shows only the selected icon, and not the deselected icon. If `true`,
|
|
|
|
* overrides the behavior of the `icons` property.
|
|
|
|
*/
|
2022-07-26 19:20:02 +03:00
|
|
|
@property({type: Boolean}) showOnlySelectedIcon = false;
|
2021-09-24 21:31:43 +03:00
|
|
|
|
2022-12-20 01:03:21 +03:00
|
|
|
// Button
|
|
|
|
@query('button') private readonly button!: HTMLButtonElement|null;
|
2022-09-16 23:51:46 +03:00
|
|
|
|
2022-12-17 04:06:12 +03:00
|
|
|
/**
|
2023-05-17 03:57:49 +03:00
|
|
|
* The value associated with this switch on form submission. `null` is
|
|
|
|
* submitted when `selected` is `false`.
|
2022-12-17 04:06:12 +03:00
|
|
|
*/
|
2023-05-17 03:57:49 +03:00
|
|
|
@property() value = 'on';
|
2022-12-13 06:01:29 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The HTML name to use in form submission.
|
|
|
|
*/
|
2023-05-17 03:57:49 +03:00
|
|
|
get name() {
|
|
|
|
return this.getAttribute('name') ?? '';
|
|
|
|
}
|
|
|
|
set name(name: string) {
|
|
|
|
this.setAttribute('name', name);
|
|
|
|
}
|
2022-12-13 06:01:29 +03:00
|
|
|
|
|
|
|
/**
|
2023-05-17 03:57:49 +03:00
|
|
|
* The associated form element with which this element's value will submit.
|
2022-12-13 06:01:29 +03:00
|
|
|
*/
|
2023-05-17 03:57:49 +03:00
|
|
|
get form() {
|
|
|
|
return this.internals.form;
|
|
|
|
}
|
2022-12-13 06:01:29 +03:00
|
|
|
|
2023-05-17 03:57:49 +03:00
|
|
|
/**
|
|
|
|
* The labels this element is associated with.
|
|
|
|
*/
|
|
|
|
get labels() {
|
|
|
|
return this.internals.labels;
|
2021-09-24 21:31:43 +03:00
|
|
|
}
|
|
|
|
|
2023-05-17 03:57:49 +03:00
|
|
|
private readonly internals =
|
|
|
|
(this as HTMLElement /* needed for closure */).attachInternals();
|
|
|
|
|
2021-12-29 20:45:59 +03:00
|
|
|
constructor() {
|
|
|
|
super();
|
2023-04-19 23:24:26 +03:00
|
|
|
if (!isServer) {
|
|
|
|
this.addEventListener('click', (event: MouseEvent) => {
|
|
|
|
if (!isActivationClick(event)) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
this.button?.focus();
|
|
|
|
if (this.button != null) {
|
|
|
|
// this triggers the click behavior, and the ripple
|
|
|
|
dispatchActivationClick(this.button);
|
|
|
|
}
|
|
|
|
});
|
|
|
|
}
|
2021-12-29 20:45:59 +03:00
|
|
|
}
|
2021-09-24 21:31:43 +03:00
|
|
|
|
2023-05-17 03:57:49 +03:00
|
|
|
protected override update(changed: PropertyValues<Switch>) {
|
|
|
|
const state = String(this.selected);
|
|
|
|
this.internals.setFormValue(this.selected ? this.value : null, state);
|
|
|
|
super.update(changed);
|
|
|
|
}
|
|
|
|
|
2021-09-24 21:31:43 +03:00
|
|
|
protected override render(): TemplateResult {
|
2022-12-20 01:03:21 +03:00
|
|
|
// NOTE: buttons must use only [phrasing
|
|
|
|
// content](https://html.spec.whatwg.org/multipage/dom.html#phrasing-content)
|
|
|
|
// children, which includes custom elements, but not `div`s
|
2021-09-24 21:31:43 +03:00
|
|
|
return html`
|
|
|
|
<button
|
2023-05-26 20:05:54 +03:00
|
|
|
id="switch"
|
2021-09-24 21:31:43 +03:00
|
|
|
type="button"
|
2023-05-10 06:16:54 +03:00
|
|
|
class="switch ${classMap(this.getRenderClasses())}"
|
2021-09-24 21:31:43 +03:00
|
|
|
role="switch"
|
|
|
|
aria-checked="${this.selected}"
|
2023-04-25 00:10:06 +03:00
|
|
|
aria-label=${(this as ARIAMixin).ariaLabel || nothing}
|
2022-07-23 01:26:44 +03:00
|
|
|
?disabled=${this.disabled}
|
2021-09-24 21:31:43 +03:00
|
|
|
@click=${this.handleClick}
|
|
|
|
>
|
2023-05-01 23:49:04 +03:00
|
|
|
<md-focus-ring></md-focus-ring>
|
2023-05-10 06:16:54 +03:00
|
|
|
<span class="track">
|
2021-09-24 21:31:43 +03:00
|
|
|
${this.renderHandle()}
|
2022-12-20 01:03:21 +03:00
|
|
|
</span>
|
2021-09-24 21:31:43 +03:00
|
|
|
</button>
|
|
|
|
`;
|
|
|
|
}
|
|
|
|
|
2022-12-20 01:03:21 +03:00
|
|
|
private getRenderClasses(): ClassInfo {
|
2021-09-24 21:31:43 +03:00
|
|
|
return {
|
2023-05-10 06:16:54 +03:00
|
|
|
'switch--selected': this.selected,
|
|
|
|
'switch--unselected': !this.selected,
|
2021-09-24 21:31:43 +03:00
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2023-04-25 20:40:12 +03:00
|
|
|
private renderHandle() {
|
2022-05-11 02:01:43 +03:00
|
|
|
const classes = {
|
2023-05-17 01:36:44 +03:00
|
|
|
'with-icon': this.icons || (this.showOnlySelectedIcon && this.selected),
|
2022-05-11 02:01:43 +03:00
|
|
|
};
|
2021-09-24 21:31:43 +03:00
|
|
|
return html`
|
2023-05-10 06:16:54 +03:00
|
|
|
<span class="handle-container">
|
2023-05-26 20:05:54 +03:00
|
|
|
<md-ripple for="switch" ?disabled="${this.disabled}"></md-ripple>
|
2023-05-10 06:16:54 +03:00
|
|
|
<span class="handle ${classMap(classes)}">
|
2022-05-11 02:01:43 +03:00
|
|
|
${this.shouldShowIcons() ? this.renderIcons() : html``}
|
2022-12-20 01:03:21 +03:00
|
|
|
</span>
|
2022-05-11 02:01:43 +03:00
|
|
|
${this.renderTouchTarget()}
|
2022-12-20 01:03:21 +03:00
|
|
|
</span>
|
2021-09-24 21:31:43 +03:00
|
|
|
`;
|
|
|
|
}
|
|
|
|
|
2023-04-25 20:40:12 +03:00
|
|
|
private renderIcons() {
|
2021-09-24 21:31:43 +03:00
|
|
|
return html`
|
2023-05-10 06:16:54 +03:00
|
|
|
<div class="icons">
|
2022-04-29 21:43:31 +03:00
|
|
|
${this.renderOnIcon()}
|
2022-07-26 19:20:02 +03:00
|
|
|
${this.showOnlySelectedIcon ? html`` : this.renderOffIcon()}
|
2021-09-24 21:31:43 +03:00
|
|
|
</div>
|
|
|
|
`;
|
|
|
|
}
|
|
|
|
|
2022-05-06 20:25:04 +03:00
|
|
|
/**
|
|
|
|
* https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck%3AFILL%400%3Bwght%40500%3BGRAD%400%3Bopsz%4024
|
|
|
|
*/
|
2023-04-25 20:40:12 +03:00
|
|
|
private renderOnIcon() {
|
2021-09-24 21:31:43 +03:00
|
|
|
return html`
|
2023-05-10 06:16:54 +03:00
|
|
|
<svg class="icon icon--on" viewBox="0 0 24 24">
|
2022-05-06 20:25:04 +03:00
|
|
|
<path d="M9.55 18.2 3.65 12.3 5.275 10.675 9.55 14.95 18.725 5.775 20.35 7.4Z"/>
|
2021-09-24 21:31:43 +03:00
|
|
|
</svg>
|
|
|
|
`;
|
|
|
|
}
|
|
|
|
|
2022-05-06 20:25:04 +03:00
|
|
|
/**
|
|
|
|
* https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Aclose%3AFILL%400%3Bwght%40500%3BGRAD%400%3Bopsz%4024
|
|
|
|
*/
|
2023-04-25 20:40:12 +03:00
|
|
|
private renderOffIcon() {
|
2021-09-24 21:31:43 +03:00
|
|
|
return html`
|
2023-05-10 06:16:54 +03:00
|
|
|
<svg class="icon icon--off" viewBox="0 0 24 24">
|
2022-05-06 20:25:04 +03:00
|
|
|
<path d="M6.4 19.2 4.8 17.6 10.4 12 4.8 6.4 6.4 4.8 12 10.4 17.6 4.8 19.2 6.4 13.6 12 19.2 17.6 17.6 19.2 12 13.6Z"/>
|
2021-09-24 21:31:43 +03:00
|
|
|
</svg>
|
|
|
|
`;
|
|
|
|
}
|
|
|
|
|
2023-04-25 20:40:12 +03:00
|
|
|
private renderTouchTarget() {
|
2023-05-10 06:16:54 +03:00
|
|
|
return html`<span class="touch"></span>`;
|
2022-05-06 20:25:04 +03:00
|
|
|
}
|
|
|
|
|
2022-05-11 02:01:43 +03:00
|
|
|
private shouldShowIcons(): boolean {
|
2022-07-26 19:20:02 +03:00
|
|
|
return this.icons || this.showOnlySelectedIcon;
|
2022-05-06 20:25:04 +03:00
|
|
|
}
|
|
|
|
|
2022-12-20 01:03:21 +03:00
|
|
|
private handleClick() {
|
|
|
|
if (this.disabled) {
|
2022-03-23 04:18:05 +03:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
this.selected = !this.selected;
|
2022-12-15 03:49:11 +03:00
|
|
|
this.dispatchEvent(
|
|
|
|
new InputEvent('input', {bubbles: true, composed: true}));
|
|
|
|
// Bubbles but does not compose to mimic native browser <input> & <select>
|
|
|
|
// Additionally, native change event is not an InputEvent.
|
|
|
|
this.dispatchEvent(new Event('change', {bubbles: true}));
|
2021-09-24 21:31:43 +03:00
|
|
|
}
|
2023-05-17 03:57:49 +03:00
|
|
|
|
|
|
|
/** @private */
|
|
|
|
formResetCallback() {
|
|
|
|
// The selected property does not reflect, so the original attribute set by
|
|
|
|
// the user is used to determine the default value.
|
|
|
|
this.selected = this.hasAttribute('selected');
|
|
|
|
}
|
|
|
|
|
|
|
|
/** @private */
|
|
|
|
formStateRestoreCallback(state: string) {
|
|
|
|
this.selected = state === 'true';
|
|
|
|
}
|
2021-09-24 21:31:43 +03:00
|
|
|
}
|