UNPKG

@esri/calcite-components

Version:

Web Components for Esri's Calcite Design System.

1,022 lines (1,021 loc) • 32 kB
/*! * All material copyright ESRI, All Rights Reserved, unless otherwise specified. * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details. * v1.5.0-next.4 */ import { h, Host } from "@stencil/core"; import { getElementDir, getSlotted, setRequestedIcon } from "../../utils/dom"; import { connectForm, disconnectForm, HiddenFormInputSlot, submitForm } from "../../utils/form"; import { connectInteractive, disconnectInteractive, updateHostInteraction } from "../../utils/interactive"; import { connectLabel, disconnectLabel, getLabelText } from "../../utils/label"; import { componentLoaded, setComponentLoaded, setUpLoadableComponent } from "../../utils/loadable"; import { connectLocalized, disconnectLocalized } from "../../utils/locale"; import { createObserver } from "../../utils/observers"; import { CSS_UTILITY } from "../../utils/resources"; import { connectMessages, disconnectMessages, setUpMessages, updateMessages } from "../../utils/t9n"; import { CSS, SLOTS } from "./resources"; /** * @slot action - A slot for positioning a button next to the component. */ export class InputText { constructor() { this.previousValueOrigin = "initial"; this.mutationObserver = createObserver("mutation", () => this.setDisabledAction()); this.userChangedValue = false; //-------------------------------------------------------------------------- // // Private Methods // //-------------------------------------------------------------------------- this.keyDownHandler = (event) => { if (this.readOnly || this.disabled) { return; } if (this.isClearable && event.key === "Escape") { this.clearInputTextValue(event); event.preventDefault(); } if (event.key === "Enter" && !event.defaultPrevented) { if (submitForm(this)) { event.preventDefault(); } } }; this.clearInputTextValue = (nativeEvent) => { this.setValue({ committing: true, nativeEvent, origin: "user", value: "" }); }; this.emitChangeIfUserModified = () => { if (this.previousValueOrigin === "user" && this.value !== this.previousEmittedValue) { this.calciteInputTextChange.emit(); this.setPreviousEmittedValue(this.value); } }; this.inputTextBlurHandler = () => { this.calciteInternalInputTextBlur.emit({ element: this.childEl, value: this.value }); this.emitChangeIfUserModified(); }; this.clickHandler = (event) => { if (this.disabled) { return; } const slottedActionEl = getSlotted(this.el, "action"); if (event.target !== slottedActionEl) { this.setFocus(); } }; this.inputTextFocusHandler = () => { this.calciteInternalInputTextFocus.emit({ element: this.childEl, value: this.value }); }; this.inputTextInputHandler = (nativeEvent) => { if (this.disabled || this.readOnly) { return; } this.setValue({ nativeEvent, origin: "user", value: nativeEvent.target.value }); }; this.inputTextKeyDownHandler = (event) => { if (this.disabled || this.readOnly) { return; } if (event.key === "Enter") { this.emitChangeIfUserModified(); } }; this.hiddenInputChangeHandler = (event) => { if (event.target.name === this.name) { this.setValue({ value: event.target.value, origin: "direct" }); } event.stopPropagation(); }; this.setChildElRef = (el) => { this.childEl = el; }; this.setInputValue = (newInputValue) => { if (!this.childEl) { return; } this.childEl.value = newInputValue; }; this.setPreviousEmittedValue = (value) => { this.previousEmittedValue = value; }; this.setPreviousValue = (value) => { this.previousValue = value; }; this.setValue = ({ committing = false, nativeEvent, origin, previousValue, value }) => { this.setPreviousValue(previousValue ?? this.value); this.previousValueOrigin = origin; this.userChangedValue = origin === "user" && value !== this.value; this.value = value; if (origin === "direct") { this.setInputValue(value); this.setPreviousEmittedValue(value); } if (nativeEvent) { const calciteInputTextInputEvent = this.calciteInputTextInput.emit(); if (calciteInputTextInputEvent.defaultPrevented) { this.value = this.previousValue; } else if (committing) { this.emitChangeIfUserModified(); } } }; this.alignment = "start"; this.autofocus = false; this.clearable = false; this.disabled = false; this.form = undefined; this.hidden = false; this.icon = undefined; this.iconFlipRtl = false; this.label = undefined; this.loading = false; this.maxLength = undefined; this.minLength = undefined; this.name = undefined; this.placeholder = undefined; this.prefixText = undefined; this.readOnly = false; this.required = false; this.scale = "m"; this.status = "idle"; this.autocomplete = undefined; this.inputMode = "text"; this.enterKeyHint = undefined; this.pattern = undefined; this.suffixText = undefined; this.editingEnabled = false; this.value = ""; this.messages = undefined; this.messageOverrides = undefined; this.effectiveLocale = undefined; this.defaultMessages = undefined; this.slottedActionElDisabledInternally = false; } disabledWatcher() { this.setDisabledAction(); } onMessagesChange() { /* wired up by t9n util */ } valueWatcher(newValue, previousValue) { if (!this.userChangedValue) { this.setValue({ origin: "direct", previousValue, value: !newValue ? "" : newValue }); } this.userChangedValue = false; } updateRequestedIcon() { this.requestedIcon = setRequestedIcon({}, this.icon, "text"); } get isClearable() { return this.clearable && this.value.length > 0; } effectiveLocaleChange() { updateMessages(this, this.effectiveLocale); } //-------------------------------------------------------------------------- // // Lifecycle // //-------------------------------------------------------------------------- connectedCallback() { connectInteractive(this); connectLocalized(this); connectMessages(this); this.inlineEditableEl = this.el.closest("calcite-inline-editable"); if (this.inlineEditableEl) { this.editingEnabled = this.inlineEditableEl.editingEnabled || false; } this.setPreviousEmittedValue(this.value); this.setPreviousValue(this.value); connectLabel(this); connectForm(this); this.mutationObserver?.observe(this.el, { childList: true }); this.setDisabledAction(); this.el.addEventListener("calciteInternalHiddenInputChange", this.hiddenInputChangeHandler); } disconnectedCallback() { disconnectInteractive(this); disconnectLabel(this); disconnectForm(this); disconnectLocalized(this); disconnectMessages(this); this.mutationObserver?.disconnect(); this.el.removeEventListener("calciteInternalHiddenInputChange", this.hiddenInputChangeHandler); } async componentWillLoad() { setUpLoadableComponent(this); this.requestedIcon = setRequestedIcon({}, this.icon, "text"); await setUpMessages(this); } componentDidLoad() { setComponentLoaded(this); } componentDidRender() { updateHostInteraction(this); } //-------------------------------------------------------------------------- // // Public Methods // //-------------------------------------------------------------------------- /** Sets focus on the component. */ async setFocus() { await componentLoaded(this); this.childEl?.focus(); } /** Selects the text of the component's `value`. */ async selectText() { this.childEl?.select(); } onLabelClick() { this.setFocus(); } onFormReset() { this.setValue({ origin: "reset", value: this.defaultValue }); } syncHiddenFormInput(input) { if (this.minLength != null) { input.minLength = this.minLength; } if (this.maxLength != null) { input.maxLength = this.maxLength; } } setDisabledAction() { const slottedActionEl = getSlotted(this.el, "action"); if (!slottedActionEl) { return; } if (this.disabled) { if (slottedActionEl.getAttribute("disabled") == null) { this.slottedActionElDisabledInternally = true; } slottedActionEl.setAttribute("disabled", ""); } else if (this.slottedActionElDisabledInternally) { slottedActionEl.removeAttribute("disabled"); this.slottedActionElDisabledInternally = false; } } // -------------------------------------------------------------------------- // // Render Methods // // -------------------------------------------------------------------------- render() { const dir = getElementDir(this.el); const loader = (h("div", { class: CSS.loader }, h("calcite-progress", { label: this.messages.loading, type: "indeterminate" }))); const inputClearButton = (h("button", { "aria-label": this.messages.clear, class: CSS.clearButton, disabled: this.disabled || this.readOnly, onClick: this.clearInputTextValue, tabIndex: -1, type: "button" }, h("calcite-icon", { icon: "x", scale: this.scale === "l" ? "m" : "s" }))); const iconEl = (h("calcite-icon", { class: CSS.inputIcon, flipRtl: this.iconFlipRtl, icon: this.requestedIcon, scale: this.scale === "l" ? "m" : "s" })); const prefixText = h("div", { class: CSS.prefix }, this.prefixText); const suffixText = h("div", { class: CSS.suffix }, this.suffixText); const childEl = (h("input", { "aria-label": getLabelText(this), autocomplete: this.autocomplete, autofocus: this.autofocus ? true : null, class: { [CSS.editingEnabled]: this.editingEnabled, [CSS.inlineChild]: !!this.inlineEditableEl }, defaultValue: this.defaultValue, disabled: this.disabled ? true : null, enterKeyHint: this.enterKeyHint, inputMode: this.inputMode, maxLength: this.maxLength, minLength: this.minLength, name: this.name, onBlur: this.inputTextBlurHandler, onFocus: this.inputTextFocusHandler, onInput: this.inputTextInputHandler, onKeyDown: this.inputTextKeyDownHandler, pattern: this.pattern, placeholder: this.placeholder || "", readOnly: this.readOnly, required: this.required ? true : null, tabIndex: this.disabled || (this.inlineEditableEl && !this.editingEnabled) ? -1 : null, type: "text", value: this.value, // eslint-disable-next-line react/jsx-sort-props ref: this.setChildElRef })); return (h(Host, { onClick: this.clickHandler, onKeyDown: this.keyDownHandler }, h("div", { class: { [CSS.inputWrapper]: true, [CSS_UTILITY.rtl]: dir === "rtl" } }, this.prefixText ? prefixText : null, h("div", { class: CSS.wrapper }, childEl, this.isClearable ? inputClearButton : null, this.requestedIcon ? iconEl : null, this.loading ? loader : null), h("div", { class: CSS.actionWrapper }, h("slot", { name: SLOTS.action })), this.suffixText ? suffixText : null, h(HiddenFormInputSlot, { component: this })))); } static get is() { return "calcite-input-text"; } static get encapsulation() { return "shadow"; } static get originalStyleUrls() { return { "$": ["input-text.scss"] }; } static get styleUrls() { return { "$": ["input-text.css"] }; } static get assetsDirs() { return ["assets"]; } static get properties() { return { "alignment": { "type": "string", "mutable": false, "complexType": { "original": "Position", "resolved": "\"end\" | \"start\"", "references": { "Position": { "location": "import", "path": "../interfaces" } } }, "required": false, "optional": false, "docs": { "tags": [], "text": "Specifies the text alignment of the component's value." }, "attribute": "alignment", "reflect": true, "defaultValue": "\"start\"" }, "autofocus": { "type": "boolean", "mutable": false, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[autofocus](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)" }], "text": "When `true`, the component is focused on page load. Only one element can contain `autofocus`. If multiple elements have `autofocus`, the first element will receive focus." }, "attribute": "autofocus", "reflect": true, "defaultValue": "false" }, "clearable": { "type": "boolean", "mutable": false, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "required": false, "optional": false, "docs": { "tags": [], "text": "When `true`, a clear button is displayed when the component has a value." }, "attribute": "clearable", "reflect": true, "defaultValue": "false" }, "disabled": { "type": "boolean", "mutable": false, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[disabled](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled)" }], "text": "When `true`, interaction is prevented and the component is displayed with lower opacity." }, "attribute": "disabled", "reflect": true, "defaultValue": "false" }, "form": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [], "text": "The ID of the form that will be associated with the component.\n\nWhen not set, the component will be associated with its ancestor form element, if any." }, "attribute": "form", "reflect": true }, "hidden": { "type": "boolean", "mutable": false, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[hidden](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/hidden)" }], "text": "When `true`, the component will not be visible." }, "attribute": "hidden", "reflect": true, "defaultValue": "false" }, "icon": { "type": "any", "mutable": false, "complexType": { "original": "string | boolean", "resolved": "boolean | string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "futureBreaking", "text": "Remove boolean type as it is not supported." }], "text": "Specifies an icon to display." }, "attribute": "icon", "reflect": true }, "iconFlipRtl": { "type": "boolean", "mutable": false, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "required": false, "optional": false, "docs": { "tags": [], "text": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`)." }, "attribute": "icon-flip-rtl", "reflect": true, "defaultValue": "false" }, "label": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [], "text": "Accessible name for the component's button or hyperlink." }, "attribute": "label", "reflect": false }, "loading": { "type": "boolean", "mutable": false, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "required": false, "optional": false, "docs": { "tags": [], "text": "When `true`, the component is in the loading state and `calcite-progress` is displayed." }, "attribute": "loading", "reflect": true, "defaultValue": "false" }, "maxLength": { "type": "number", "mutable": false, "complexType": { "original": "number", "resolved": "number", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength)" }], "text": "Specifies the maximum length of text for the component's value." }, "attribute": "max-length", "reflect": true }, "minLength": { "type": "number", "mutable": false, "complexType": { "original": "number", "resolved": "number", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength)" }], "text": "Specifies the minimum length of text for the component's value." }, "attribute": "min-length", "reflect": true }, "name": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)" }], "text": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission." }, "attribute": "name", "reflect": true }, "placeholder": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder)" }], "text": "Specifies placeholder text for the component." }, "attribute": "placeholder", "reflect": false }, "prefixText": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [], "text": "Adds text to the start of the component." }, "attribute": "prefix-text", "reflect": false }, "readOnly": { "type": "boolean", "mutable": false, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)" }], "text": "When `true`, the component's value can be read, but cannot be modified." }, "attribute": "read-only", "reflect": true, "defaultValue": "false" }, "required": { "type": "boolean", "mutable": false, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "required": false, "optional": false, "docs": { "tags": [], "text": "When `true`, the component must have a value in order for the form to submit." }, "attribute": "required", "reflect": true, "defaultValue": "false" }, "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": "Specifies the size of the component." }, "attribute": "scale", "reflect": true, "defaultValue": "\"m\"" }, "status": { "type": "string", "mutable": false, "complexType": { "original": "Status", "resolved": "\"idle\" | \"invalid\" | \"valid\"", "references": { "Status": { "location": "import", "path": "../interfaces" } } }, "required": false, "optional": false, "docs": { "tags": [], "text": "Specifies the status of the input field, which determines message and icons." }, "attribute": "status", "reflect": true, "defaultValue": "\"idle\"" }, "autocomplete": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)" }], "text": "Specifies the type of content to autocomplete, for use in forms.\nRead the native attribute's documentation on MDN for more info." }, "attribute": "autocomplete", "reflect": false }, "inputMode": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[step](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode)" }], "text": "Specifies the type of content to help devices display an appropriate virtual keyboard.\nRead the native attribute's documentation on MDN for more info." }, "attribute": "input-mode", "reflect": false, "defaultValue": "\"text\"" }, "enterKeyHint": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[step](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)" }], "text": "Specifies the action label or icon for the Enter key on virtual keyboards.\nRead the native attribute's documentation on MDN for more info." }, "attribute": "enter-key-hint", "reflect": false }, "pattern": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "mdn", "text": "[step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern)" }], "text": "Specifies a regex pattern the component's `value` must match for validation.\nRead the native attribute's documentation on MDN for more info." }, "attribute": "pattern", "reflect": false }, "suffixText": { "type": "string", "mutable": false, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [], "text": "Adds text to the end of the component." }, "attribute": "suffix-text", "reflect": false }, "editingEnabled": { "type": "boolean", "mutable": true, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "required": false, "optional": false, "docs": { "tags": [{ "name": "internal", "text": undefined }], "text": "" }, "attribute": "editing-enabled", "reflect": true, "defaultValue": "false" }, "value": { "type": "string", "mutable": true, "complexType": { "original": "string", "resolved": "string", "references": {} }, "required": false, "optional": false, "docs": { "tags": [], "text": "The component's value." }, "attribute": "value", "reflect": false, "defaultValue": "\"\"" }, "messages": { "type": "unknown", "mutable": true, "complexType": { "original": "InputTextMessages", "resolved": "{ clear: string; loading: string; }", "references": { "InputTextMessages": { "location": "import", "path": "./assets/input-text/t9n" } } }, "required": false, "optional": false, "docs": { "tags": [{ "name": "internal", "text": undefined }], "text": "Made into a prop for testing purposes only" } }, "messageOverrides": { "type": "unknown", "mutable": true, "complexType": { "original": "Partial<InputTextMessages>", "resolved": "{ clear?: string; loading?: string; }", "references": { "Partial": { "location": "global" }, "InputTextMessages": { "location": "import", "path": "./assets/input-text/t9n" } } }, "required": false, "optional": false, "docs": { "tags": [], "text": "Use this property to override individual strings used by the component." } } }; } static get states() { return { "effectiveLocale": {}, "defaultMessages": {}, "slottedActionElDisabledInternally": {} }; } static get events() { return [{ "method": "calciteInternalInputTextFocus", "name": "calciteInternalInputTextFocus", "bubbles": true, "cancelable": true, "composed": true, "docs": { "tags": [{ "name": "internal", "text": undefined }], "text": "" }, "complexType": { "original": "{\n element: HTMLInputElement;\n value: string;\n }", "resolved": "{ element: HTMLInputElement; value: string; }", "references": { "HTMLInputElement": { "location": "global" } } } }, { "method": "calciteInternalInputTextBlur", "name": "calciteInternalInputTextBlur", "bubbles": true, "cancelable": true, "composed": true, "docs": { "tags": [{ "name": "internal", "text": undefined }], "text": "" }, "complexType": { "original": "{ element: HTMLInputElement; value: string }", "resolved": "{ element: HTMLInputElement; value: string; }", "references": { "HTMLInputElement": { "location": "global" } } } }, { "method": "calciteInputTextInput", "name": "calciteInputTextInput", "bubbles": true, "cancelable": true, "composed": true, "docs": { "tags": [], "text": "Fires each time a new value is typed." }, "complexType": { "original": "void", "resolved": "void", "references": {} } }, { "method": "calciteInputTextChange", "name": "calciteInputTextChange", "bubbles": true, "cancelable": true, "composed": true, "docs": { "tags": [], "text": "Fires each time a new value is typed and committed." }, "complexType": { "original": "void", "resolved": "void", "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": [] } }, "selectText": { "complexType": { "signature": "() => Promise<void>", "parameters": [], "references": { "Promise": { "location": "global" } }, "return": "Promise<void>" }, "docs": { "text": "Selects the text of the component's `value`.", "tags": [] } } }; } static get elementRef() { return "el"; } static get watchers() { return [{ "propName": "disabled", "methodName": "disabledWatcher" }, { "propName": "messageOverrides", "methodName": "onMessagesChange" }, { "propName": "value", "methodName": "valueWatcher" }, { "propName": "icon", "methodName": "updateRequestedIcon" }, { "propName": "effectiveLocale", "methodName": "effectiveLocaleChange" }]; } }