@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
285 lines (284 loc) • 7.8 kB
JavaScript
/*!
* All material copyright ESRI, All Rights Reserved, unless otherwise specified.
* See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
*/
import { Component, Element, Event, h, Host, Method, Prop, Watch } from "@stencil/core";
import { focusElement } from "../../utils/dom";
import { connectLabel, disconnectLabel, getLabelText } from "../../utils/label";
import { connectForm, disconnectForm, HiddenFormInputSlot } from "../../utils/form";
import { updateHostInteraction } from "../../utils/interactive";
export class Switch {
constructor() {
//--------------------------------------------------------------------------
//
// Properties
//
//--------------------------------------------------------------------------
/** True if the switch is disabled */
this.disabled = false;
/** The scale of the switch */
this.scale = "m";
/** True if the switch is initially on
* @deprecated use 'checked' instead.
*/
this.switched = false;
/** True if the switch is initially on */
this.checked = false;
//--------------------------------------------------------------------------
//
// Private Methods
//
//--------------------------------------------------------------------------
this.keyDownHandler = (e) => {
const key = e.key;
if (!this.disabled && (key === " " || key === "Enter")) {
this.toggle();
}
};
this.clickHandler = () => {
this.toggle();
};
this.setSwitchEl = (el) => {
this.switchEl = el;
};
}
switchedWatcher(switched) {
this.checked = switched;
}
//--------------------------------------------------------------------------
//
// Public Methods
//
//--------------------------------------------------------------------------
/** Sets focus on the component. */
async setFocus() {
focusElement(this.switchEl);
}
onLabelClick() {
if (!this.disabled) {
this.toggle();
this.setFocus();
}
}
toggle() {
this.checked = !this.checked;
this.calciteSwitchChange.emit({
// todo: We should remove emmitting redudant props in event payload.
// https://github.com/Esri/calcite-components/issues/3163
switched: this.checked
});
}
//--------------------------------------------------------------------------
//
// Lifecycle
//
//--------------------------------------------------------------------------
connectedCallback() {
const initiallyChecked = this.checked || this.switched;
if (initiallyChecked) {
// if either prop is set, we ensure both are synced initially
this.switched = this.checked = initiallyChecked;
}
connectLabel(this);
connectForm(this);
}
disconnectedCallback() {
disconnectLabel(this);
disconnectForm(this);
}
componentDidRender() {
updateHostInteraction(this);
}
// --------------------------------------------------------------------------
//
// Render Methods
//
// --------------------------------------------------------------------------
render() {
return (h(Host, { onKeyDown: this.keyDownHandler },
h("div", { "aria-checked": this.checked.toString(), "aria-label": getLabelText(this), class: "container", onClick: this.clickHandler, ref: this.setSwitchEl, role: "switch", tabIndex: 0 },
h("div", { class: "track" },
h("div", { class: "handle" })),
h(HiddenFormInputSlot, { component: this }))));
}
static get is() { return "calcite-switch"; }
static get encapsulation() { return "shadow"; }
static get originalStyleUrls() { return {
"$": ["switch.scss"]
}; }
static get styleUrls() { return {
"$": ["switch.css"]
}; }
static get properties() { return {
"disabled": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "True if the switch is disabled"
},
"attribute": "disabled",
"reflect": true,
"defaultValue": "false"
},
"label": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "Applies to the aria-label attribute on the switch"
},
"attribute": "label",
"reflect": false
},
"name": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "The name of the switch input"
},
"attribute": "name",
"reflect": true
},
"scale": {
"type": "string",
"mutable": false,
"complexType": {
"original": "Scale",
"resolved": "\"l\" | \"m\" | \"s\"",
"references": {
"Scale": {
"location": "import",
"path": "../interfaces"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "The scale of the switch"
},
"attribute": "scale",
"reflect": true,
"defaultValue": "\"m\""
},
"switched": {
"type": "boolean",
"mutable": true,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [{
"name": "deprecated",
"text": "use 'checked' instead."
}],
"text": "True if the switch is initially on"
},
"attribute": "switched",
"reflect": false,
"defaultValue": "false"
},
"checked": {
"type": "boolean",
"mutable": true,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "True if the switch is initially on"
},
"attribute": "checked",
"reflect": true,
"defaultValue": "false"
},
"value": {
"type": "any",
"mutable": false,
"complexType": {
"original": "any",
"resolved": "any",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "The value of the switch input"
},
"attribute": "value",
"reflect": false
}
}; }
static get events() { return [{
"method": "calciteSwitchChange",
"name": "calciteSwitchChange",
"bubbles": true,
"cancelable": true,
"composed": true,
"docs": {
"tags": [],
"text": "Fires when the checked value has changed."
},
"complexType": {
"original": "any",
"resolved": "any",
"references": {}
}
}]; }
static get methods() { return {
"setFocus": {
"complexType": {
"signature": "() => Promise<void>",
"parameters": [],
"references": {
"Promise": {
"location": "global"
}
},
"return": "Promise<void>"
},
"docs": {
"text": "Sets focus on the component.",
"tags": []
}
}
}; }
static get elementRef() { return "el"; }
static get watchers() { return [{
"propName": "switched",
"methodName": "switchedWatcher"
}]; }
}