@six-group/ui-library 0.0.0-insider.0014c08

package/dist/collection/components/six-range/six-range.js

@@ -0,0 +1,651 @@
+import { h } from "@stencil/core";
+import FormControl from "../../functional-components/form-control/form-control";
+import { hasSlot } from "../../utils/slot";
+import { EventListeners } from "../../utils/event-listeners";
+let id = 0;
+/**
+ * @since 1.0
+ * @status stable
+ *
+ * Forked from https://github.com/shoelace-style/shoelace version v2.0.0-beta27.
+ *
+ * @slot label - The input's label. Alternatively, you can use the label prop.
+ * @slot help-text - Help text that describes how to use the input. Alternatively, you can use the help-text prop.
+ * @slot error-text - Error text that is shown for validation errors. Alternatively, you can use the error-text prop.
+ *
+ * @part base - The component's base wrapper.
+ * @part input - The native range input.
+ * @part tooltip - The range tooltip.
+ */
+export class SixRange {
+    constructor() {
+        this.inputId = `input-${++id}`;
+        this.labelId = `input-label-${id}`;
+        this.helpTextId = `input-help-text-${id}`;
+        this.errorTextId = `input-error-text-${id}`;
+        this.eventListeners = new EventListeners();
+        this.hasFocus = false;
+        this.hasHelpTextSlot = false;
+        this.hasErrorTextSlot = false;
+        this.hasLabelSlot = false;
+        this.hasTooltip = false;
+        /** The input's name attribute. */
+        this.name = '';
+        /** The input's value attribute. */
+        this.value = 0;
+        /** Set to true to show an asterisk beneath the label. */
+        this.required = false;
+        /** The range's help text. Alternatively, you can use the help-text slot. */
+        this.helpText = '';
+        /** Set to true to disable the input. */
+        this.disabled = false;
+        /** The label text. */
+        this.label = '';
+        /** The error message shown, if `invalid` is set to true.  */
+        this.errorText = '';
+        /** If this property is set to true and an error message is provided by `errorText`, the error message is displayed.  */
+        this.invalid = false;
+        /** The input's min attribute. */
+        this.min = 0;
+        /** The input's max attribute. */
+        this.max = 100;
+        /** The input's step attribute. */
+        this.step = 1;
+        /** The preferred placedment of the tooltip. */
+        this.tooltip = 'top';
+        /** A function used to format the tooltip's value. */
+        this.tooltipFormatter = (value) => value.toString();
+        this.handleInput = () => {
+            if (this.nativeInput != null) {
+                this.update(parseFloat(this.nativeInput.value));
+            }
+            requestAnimationFrame(() => {
+                this.sixChange.emit();
+            });
+        };
+        this.handleBlur = () => {
+            var _a;
+            this.hasFocus = false;
+            this.hasTooltip = false;
+            this.sixBlur.emit();
+            if (this.nativeInput != null) {
+                (_a = this.resizeObserver) === null || _a === void 0 ? void 0 : _a.unobserve(this.nativeInput);
+            }
+        };
+        this.handleFocus = () => {
+            var _a;
+            this.hasFocus = true;
+            this.hasTooltip = true;
+            this.sixFocus.emit();
+            if (this.nativeInput != null) {
+                (_a = this.resizeObserver) === null || _a === void 0 ? void 0 : _a.observe(this.nativeInput);
+            }
+        };
+        this.handleSlotChange = () => {
+            this.hasHelpTextSlot = hasSlot(this.host, 'help-text');
+            this.hasLabelSlot = hasSlot(this.host, 'label');
+            this.hasErrorTextSlot = hasSlot(this.host, 'error-text');
+        };
+        this.handleTouchStart = () => {
+            this.setFocus();
+        };
+    }
+    handleLabelChange() {
+        this.handleSlotChange();
+    }
+    handleValueChange() {
+        this.update();
+    }
+    connectedCallback() {
+        var _a;
+        (_a = this.host.shadowRoot) === null || _a === void 0 ? void 0 : _a.addEventListener('slotchange', this.handleSlotChange);
+    }
+    componentWillLoad() {
+        this.update();
+        this.handleSlotChange();
+    }
+    componentDidLoad() {
+        const nativeInput = this.nativeInput;
+        if (nativeInput == null) {
+            return;
+        }
+        this.update();
+        this.resizeObserver = new ResizeObserver(() => this.update());
+    }
+    disconnectedCallback() {
+        var _a;
+        (_a = this.host.shadowRoot) === null || _a === void 0 ? void 0 : _a.removeEventListener('slotchange', this.handleSlotChange);
+        this.eventListeners.removeAll();
+    }
+    componentDidUpdate() {
+        const { min, max } = this.getMinMax();
+        this.syncTooltip(min, max, this.value);
+    }
+    getMinMax() {
+        var _a, _b;
+        const min = (_a = Number(this.min)) !== null && _a !== void 0 ? _a : 0;
+        const max = (_b = Number(this.max)) !== null && _b !== void 0 ? _b : 0;
+        return { min, max };
+    }
+    /** Sets focus on the input. */
+    async setFocus(options) {
+        var _a;
+        (_a = this.nativeInput) === null || _a === void 0 ? void 0 : _a.focus(options);
+    }
+    /** Removes focus from the input. */
+    async removeFocus() {
+        var _a;
+        (_a = this.nativeInput) === null || _a === void 0 ? void 0 : _a.blur();
+    }
+    syncTooltip(min, max, value) {
+        if (this.tooltip !== 'none' && this.nativeInput != null && this.output != null) {
+            const percent = Math.max(0, (value - min) / (max - min));
+            const inputWidth = this.nativeInput.offsetWidth;
+            const tooltipWidth = this.output.offsetWidth;
+            const thumbSize = getComputedStyle(this.nativeInput).getPropertyValue('--thumb-size');
+            const x = `calc(${inputWidth * percent}px - calc(calc(${percent} * ${thumbSize}) - calc(${thumbSize} / 2)))`;
+            this.output.style.transform = `translateX(${x})`;
+            this.output.style.marginLeft = `-${tooltipWidth / 2}px`;
+        }
+    }
+    isFirefox() {
+        return navigator.userAgent.toLowerCase().indexOf('firefox') > -1;
+    }
+    update(updateValue) {
+        var _a, _b;
+        if (updateValue != null) {
+            this.value = updateValue;
+        }
+        const min = (_a = Number(this.min)) !== null && _a !== void 0 ? _a : 0;
+        const max = (_b = Number(this.max)) !== null && _b !== void 0 ? _b : 0;
+        let value;
+        const parsedValue = parseFloat(this.value);
+        if (isNaN(parsedValue)) {
+            value = this.getDefaultValue(min, max);
+        }
+        else {
+            value = parsedValue;
+        }
+        if (this.nativeInput != null) {
+            // The value may have constraints, so we set the native control's
+            // value and sync it back to ensure it adheres to min, max, and step
+            // properly.
+            this.nativeInput.value = value.toString();
+            this.value = parseFloat(this.nativeInput.value);
+        }
+        else {
+            this.value = value;
+        }
+        this.calculateColorRunnableTrack(min, max, this.value);
+        this.syncTooltip(min, max, this.value);
+    }
+    /**
+     * from https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/range#value
+     */
+    getDefaultValue(min, max) {
+        return max < min ? min : min + (max - min) / 2;
+    }
+    /**
+     * For Firefox this functionality is not needed because it is supported by standard CSS.
+     */
+    calculateColorRunnableTrack(min, max, value) {
+        if (!this.isFirefox() && this.nativeInput != null) {
+            const percent = Math.ceil(((value - min) / (max - min)) * 100);
+            this.nativeInput.style.background =
+                '-webkit-linear-gradient(left, var(--track-color) 0%, var(--track-color) ' +
+                    percent +
+                    '%, var(--six-color-web-rock-300) ' +
+                    percent +
+                    '%)';
+        }
+    }
+    render() {
+        return (h(FormControl, { key: '9b01de18ce3b59ec8fe5c60edbf94ca2d7911d9d', inputId: this.inputId, label: this.label, labelId: this.labelId, hasLabelSlot: this.hasLabelSlot, helpTextId: this.helpTextId, helpText: this.helpText, hasHelpTextSlot: this.hasHelpTextSlot, size: "medium", errorTextId: this.errorTextId, errorText: this.errorText, hasErrorTextSlot: this.hasErrorTextSlot, errorTextCount: this.errorTextCount, disabled: this.disabled, required: this.required, displayError: this.invalid }, h("div", { key: '66581ce24488802b0b81030aa916dfc6880e4498', part: "base", class: {
+                range: true,
+                // States
+                'range--disabled': this.disabled,
+                'range--focused': this.hasFocus,
+                'range--tooltip-visible': this.hasTooltip,
+                'range--tooltip-top': this.tooltip === 'top',
+                'range--tooltip-bottom': this.tooltip === 'bottom',
+            }, onTouchStart: this.handleTouchStart }, h("input", { key: '9e6a87ae4004e65bc9861064654bcc1a5babcd07', part: "input", ref: (el) => (this.nativeInput = el), type: "range", class: "range__control", name: this.name, disabled: this.disabled, min: this.min, max: this.max, step: this.step, value: this.value, onInput: this.handleInput, onFocus: this.handleFocus, onBlur: this.handleBlur }), this.tooltip !== 'none' && (h("output", { key: '701b765cf0c2e3e3ed3a8ebcb3853a53f389ff3b', part: "tooltip", ref: (el) => (this.output = el), class: "range__tooltip" }, this.tooltipFormatter(this.value))))));
+    }
+    static get is() { return "six-range"; }
+    static get encapsulation() { return "shadow"; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["six-range.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["six-range.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "name": {
+                "type": "string",
+                "attribute": "name",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The input's name attribute."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "''"
+            },
+            "value": {
+                "type": "number",
+                "attribute": "value",
+                "mutable": true,
+                "complexType": {
+                    "original": "number",
+                    "resolved": "number",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The input's value attribute."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "0"
+            },
+            "required": {
+                "type": "boolean",
+                "attribute": "required",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Set to true to show an asterisk beneath the label."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "false"
+            },
+            "helpText": {
+                "type": "string",
+                "attribute": "help-text",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The range's help text. Alternatively, you can use the help-text slot."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "''"
+            },
+            "disabled": {
+                "type": "boolean",
+                "attribute": "disabled",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Set to true to disable the input."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "false"
+            },
+            "label": {
+                "type": "string",
+                "attribute": "label",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The label text."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "''"
+            },
+            "errorText": {
+                "type": "string",
+                "attribute": "error-text",
+                "mutable": false,
+                "complexType": {
+                    "original": "string | string[]",
+                    "resolved": "string | string[]",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The error message shown, if `invalid` is set to true."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "''"
+            },
+            "errorTextCount": {
+                "type": "number",
+                "attribute": "error-text-count",
+                "mutable": false,
+                "complexType": {
+                    "original": "number",
+                    "resolved": "number | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "The number of error texts to be shown (if the error-text slot isn't used). Defaults to 1"
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false
+            },
+            "invalid": {
+                "type": "boolean",
+                "attribute": "invalid",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "If this property is set to true and an error message is provided by `errorText`, the error message is displayed."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "defaultValue": "false"
+            },
+            "min": {
+                "type": "number",
+                "attribute": "min",
+                "mutable": false,
+                "complexType": {
+                    "original": "number",
+                    "resolved": "number",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The input's min attribute."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "0"
+            },
+            "max": {
+                "type": "number",
+                "attribute": "max",
+                "mutable": false,
+                "complexType": {
+                    "original": "number",
+                    "resolved": "number",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The input's max attribute."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "100"
+            },
+            "step": {
+                "type": "number",
+                "attribute": "step",
+                "mutable": false,
+                "complexType": {
+                    "original": "number",
+                    "resolved": "number",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The input's step attribute."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "1"
+            },
+            "tooltip": {
+                "type": "string",
+                "attribute": "tooltip",
+                "mutable": false,
+                "complexType": {
+                    "original": "'top' | 'bottom' | 'none'",
+                    "resolved": "\"bottom\" | \"none\" | \"top\"",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The preferred placedment of the tooltip."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "'top'"
+            },
+            "tooltipFormatter": {
+                "type": "unknown",
+                "attribute": "tooltip-formatter",
+                "mutable": false,
+                "complexType": {
+                    "original": "(value: number) => string",
+                    "resolved": "(value: number) => string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "A function used to format the tooltip's value."
+                },
+                "getter": false,
+                "setter": false,
+                "defaultValue": "(value: number) => value.toString()"
+            }
+        };
+    }
+    static get states() {
+        return {
+            "hasFocus": {},
+            "hasHelpTextSlot": {},
+            "hasErrorTextSlot": {},
+            "hasLabelSlot": {},
+            "hasTooltip": {}
+        };
+    }
+    static get events() {
+        return [{
+                "method": "sixChange",
+                "name": "six-range-change",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted when the control's value changes."
+                },
+                "complexType": {
+                    "original": "EmptyPayload",
+                    "resolved": "undefined",
+                    "references": {
+                        "EmptyPayload": {
+                            "location": "import",
+                            "path": "../../utils/types",
+                            "id": "src/utils/types.ts::EmptyPayload"
+                        }
+                    }
+                }
+            }, {
+                "method": "sixBlur",
+                "name": "six-range-blur",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted when the control loses focus."
+                },
+                "complexType": {
+                    "original": "EmptyPayload",
+                    "resolved": "undefined",
+                    "references": {
+                        "EmptyPayload": {
+                            "location": "import",
+                            "path": "../../utils/types",
+                            "id": "src/utils/types.ts::EmptyPayload"
+                        }
+                    }
+                }
+            }, {
+                "method": "sixFocus",
+                "name": "six-range-focus",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted when the control gains focus."
+                },
+                "complexType": {
+                    "original": "EmptyPayload",
+                    "resolved": "undefined",
+                    "references": {
+                        "EmptyPayload": {
+                            "location": "import",
+                            "path": "../../utils/types",
+                            "id": "src/utils/types.ts::EmptyPayload"
+                        }
+                    }
+                }
+            }];
+    }
+    static get methods() {
+        return {
+            "setFocus": {
+                "complexType": {
+                    "signature": "(options?: FocusOptions) => Promise<void>",
+                    "parameters": [{
+                            "name": "options",
+                            "type": "FocusOptions | undefined",
+                            "docs": ""
+                        }],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        },
+                        "FocusOptions": {
+                            "location": "global",
+                            "id": "global::FocusOptions"
+                        }
+                    },
+                    "return": "Promise<void>"
+                },
+                "docs": {
+                    "text": "Sets focus on the input.",
+                    "tags": []
+                }
+            },
+            "removeFocus": {
+                "complexType": {
+                    "signature": "() => Promise<void>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<void>"
+                },
+                "docs": {
+                    "text": "Removes focus from the input.",
+                    "tags": []
+                }
+            }
+        };
+    }
+    static get elementRef() { return "host"; }
+    static get watchers() {
+        return [{
+                "propName": "label",
+                "methodName": "handleLabelChange"
+            }, {
+                "propName": "errorText",
+                "methodName": "handleLabelChange"
+            }, {
+                "propName": "helpText",
+                "methodName": "handleLabelChange"
+            }, {
+                "propName": "value",
+                "methodName": "handleValueChange"
+            }, {
+                "propName": "min",
+                "methodName": "handleValueChange"
+            }, {
+                "propName": "max",
+                "methodName": "handleValueChange"
+            }];
+    }
+}
+//# sourceMappingURL=six-range.js.map