import '../icon/icon'; import { classMap } from 'lit/directives/class-map.js'; import { customElement, property, query, state } from 'lit/decorators.js'; import { defaultValue } from '../../internal/default-value'; import { FormControlController } from '../../internal/form'; import { HasSlotController } from '../../internal/slot'; import { html } from 'lit'; import { ifDefined } from 'lit/directives/if-defined.js'; import { live } from 'lit/directives/live.js'; import { LocalizeController } from '../../utilities/localize'; import { watch } from '../../internal/watch'; import ShoelaceElement from '../../internal/shoelace-element'; import styles from './input.styles'; import type { CSSResultGroup } from 'lit'; import type { ShoelaceFormControl } from '../../internal/shoelace-element'; // // It's currently impossible to hide Firefox's built-in clear icon when using , so we need this // check to apply a clip-path to hide it. I know, I know…user agent sniffing is nasty but, if it fails, we only see a // redundant clear icon so nothing important is breaking. The benefits outweigh the costs for this one. See the // discussion at: https://github.com/shoelace-style/shoelace/pull/794 // // Also note that we do the Chromium check first to prevent Chrome from logging a console notice as described here: // https://github.com/shoelace-style/shoelace/issues/855 // const isChromium = navigator.userAgentData?.brands.some(b => b.brand.includes('Chromium')); const isFirefox = isChromium ? false : navigator.userAgent.includes('Firefox'); /** * @summary Inputs collect data from the user. * @documentation https://shoelace.style/components/input * @status stable * @since 2.0 * * @dependency sl-icon * * @slot label - The input's label. Alternatively, you can use the `label` attribute. * @slot prefix - Used to prepend a presentational icon or similar element to the input. * @slot suffix - Used to append a presentational icon or similar element to the input. * @slot clear-icon - An icon to use in lieu of the default clear icon. * @slot show-password-icon - An icon to use in lieu of the default show password icon. * @slot hide-password-icon - An icon to use in lieu of the default hide password icon. * @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute. * * @event sl-blur - Emitted when the control loses focus. * @event sl-change - Emitted when an alteration to the control's value is committed by the user. * @event sl-clear - Emitted when the clear button is activated. * @event sl-focus - Emitted when the control gains focus. * @event sl-input - Emitted when the control receives input. * * @csspart form-control - The form control that wraps the label, input, and help text. * @csspart form-control-label - The label's wrapper. * @csspart form-control-input - The input's wrapper. * @csspart form-control-help-text - The help text's wrapper. * @csspart base - The component's base wrapper. * @csspart input - The internal `` control. * @csspart prefix - The container that wraps the prefix. * @csspart clear-button - The clear button. * @csspart password-toggle-button - The password toggle button. * @csspart suffix - The container that wraps the suffix. */ @customElement('sl-input') export default class SlInput extends ShoelaceElement implements ShoelaceFormControl { static styles: CSSResultGroup = styles; private readonly formControlController = new FormControlController(this); private readonly hasSlotController = new HasSlotController(this, 'help-text', 'label'); private readonly localize = new LocalizeController(this); @query('.input__control') input: HTMLInputElement; @state() private hasFocus = false; @property() title = ''; // make reactive to pass through /** * The type of input. Works the same as a native `` element, but only a subset of types are supported. Defaults * to `text`. */ @property({ reflect: true }) type: | 'date' | 'datetime-local' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'text' | 'time' | 'url' = 'text'; /** The name of the input, submitted as a name/value pair with form data. */ @property() name = ''; /** The current value of the input, submitted as a name/value pair with form data. */ @property() value = ''; /** The default value of the form control. Primarily used for resetting the form control. */ @defaultValue() defaultValue = ''; /** The input's size. */ @property({ reflect: true }) size: 'small' | 'medium' | 'large' = 'medium'; /** Draws a filled input. */ @property({ type: Boolean, reflect: true }) filled = false; /** Draws a pill-style input with rounded edges. */ @property({ type: Boolean, reflect: true }) pill = false; /** The input's label. If you need to display HTML, use the `label` slot instead. */ @property() label = ''; /** The input's help text. If you need to display HTML, use the `help-text` slot instead. */ @property({ attribute: 'help-text' }) helpText = ''; /** Adds a clear button when the input is not empty. */ @property({ type: Boolean }) clearable = false; /** Disables the input. */ @property({ type: Boolean, reflect: true }) disabled = false; /** Placeholder text to show as a hint when the input is empty. */ @property() placeholder = ''; /** Makes the input readonly. */ @property({ type: Boolean, reflect: true }) readonly = false; /** Adds a button to toggle the password's visibility. Only applies to password types. */ @property({ attribute: 'password-toggle', type: Boolean }) passwordToggle = false; /** Determines whether or not the password is currently visible. Only applies to password input types. */ @property({ attribute: 'password-visible', type: Boolean }) passwordVisible = false; /** Hides the browser's built-in increment/decrement spin buttons for number inputs. */ @property({ attribute: 'no-spin-buttons', type: Boolean }) noSpinButtons = false; /** * By default, form controls are associated with the nearest containing `
` element. This attribute allows you * to place the form control outside of a form and associate it with the form that has this `id`. The form must be in * the same document or shadow root for this to work. */ @property({ reflect: true }) form = ''; /** Makes the input a required field. */ @property({ type: Boolean, reflect: true }) required = false; /** A regular expression pattern to validate input against. */ @property() pattern: string; /** The minimum length of input that will be considered valid. */ @property({ type: Number }) minlength: number; /** The maximum length of input that will be considered valid. */ @property({ type: Number }) maxlength: number; /** The input's minimum value. Only applies to date and number input types. */ @property({ type: Number }) min: number; /** The input's maximum value. Only applies to date and number input types. */ @property({ type: Number }) max: number; /** * Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is * implied, allowing any numeric value. Only applies to date and number input types. */ @property() step: number | 'any'; /** Controls whether and how text input is automatically capitalized as it is entered by the user. */ @property() autocapitalize: 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'; /** Indicates whether the browser's autocorrect feature is on or off. */ @property() autocorrect: 'off' | 'on'; /** * Specifies what permission the browser has to provide assistance in filling out form field values. Refer to * [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values. */ @property() autocomplete: string; /** Indicates that the input should receive focus on page load. */ @property({ type: Boolean }) autofocus: boolean; /** Used to customize the label or icon of the Enter key on virtual keyboards. */ @property() enterkeyhint: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'; /** Enables spell checking on the input. */ @property({ type: Boolean, converter: { // Allow "true|false" attribute values but keep the property boolean fromAttribute: value => (!value || value === 'false' ? false : true), toAttribute: value => (value ? 'true' : 'false') } }) spellcheck = true; /** * Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual * keyboard on supportive devices. */ @property() inputmode: 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'; /** Gets or sets the current value as a `Date` object. Returns `null` if the value can't be converted. */ get valueAsDate() { return this.input?.valueAsDate ?? null; } set valueAsDate(newValue: Date | null) { // We use an in-memory input instead of the one in the template because the property can be set before render const input = document.createElement('input'); input.type = 'date'; input.valueAsDate = newValue; this.value = input.value; } /** Gets or sets the current value as a number. Returns `NaN` if the value can't be converted. */ get valueAsNumber() { return this.input?.valueAsNumber ?? parseFloat(this.value); } set valueAsNumber(newValue: number) { // We use an in-memory input instead of the one in the template because the property can be set before render const input = document.createElement('input'); input.type = 'number'; input.valueAsNumber = newValue; this.value = input.value; } firstUpdated() { this.formControlController.updateValidity(); } private handleBlur() { this.hasFocus = false; this.emit('sl-blur'); } private handleChange() { this.value = this.input.value; this.emit('sl-change'); } private handleClearClick(event: MouseEvent) { this.value = ''; this.emit('sl-clear'); this.emit('sl-input'); this.emit('sl-change'); this.input.focus(); event.stopPropagation(); } private handleFocus() { this.hasFocus = true; this.emit('sl-focus'); } private handleInput() { this.value = this.input.value; this.formControlController.updateValidity(); this.emit('sl-input'); } private handleInvalid() { this.formControlController.setValidity(false); } private handleKeyDown(event: KeyboardEvent) { const hasModifier = event.metaKey || event.ctrlKey || event.shiftKey || event.altKey; // Pressing enter when focused on an input should submit the form like a native input, but we wait a tick before // submitting to allow users to cancel the keydown event if they need to if (event.key === 'Enter' && !hasModifier) { setTimeout(() => { // // When using an Input Method Editor (IME), pressing enter will cause the form to submit unexpectedly. One way // to check for this is to look at event.isComposing, which will be true when the IME is open. // // See https://github.com/shoelace-style/shoelace/pull/988 // if (!event.defaultPrevented && !event.isComposing) { this.formControlController.submit(); } }); } } private handlePasswordToggle() { this.passwordVisible = !this.passwordVisible; } @watch('disabled', { waitUntilFirstUpdate: true }) handleDisabledChange() { // Disabled form controls are always valid this.formControlController.setValidity(this.disabled); } @watch('step', { waitUntilFirstUpdate: true }) handleStepChange() { // If step changes, the value may become invalid so we need to recheck after the update. We set the new step // imperatively so we don't have to wait for the next render to report the updated validity. this.input.step = String(this.step); this.formControlController.updateValidity(); } @watch('value', { waitUntilFirstUpdate: true }) async handleValueChange() { await this.updateComplete; this.formControlController.updateValidity(); } /** Sets focus on the input. */ focus(options?: FocusOptions) { this.input.focus(options); } /** Removes focus from the input. */ blur() { this.input.blur(); } /** Selects all the text in the input. */ select() { this.input.select(); } /** Sets the start and end positions of the text selection (0-based). */ setSelectionRange( selectionStart: number, selectionEnd: number, selectionDirection: 'forward' | 'backward' | 'none' = 'none' ) { this.input.setSelectionRange(selectionStart, selectionEnd, selectionDirection); } /** Replaces a range of text with a new string. */ setRangeText( replacement: string, start?: number, end?: number, selectMode?: 'select' | 'start' | 'end' | 'preserve' ) { // @ts-expect-error - start, end, and selectMode are optional this.input.setRangeText(replacement, start, end, selectMode); if (this.value !== this.input.value) { this.value = this.input.value; } } /** Displays the browser picker for an input element (only works if the browser supports it for the input type). */ showPicker() { if ('showPicker' in HTMLInputElement.prototype) { this.input.showPicker(); } } /** Increments the value of a numeric input type by the value of the step attribute. */ stepUp() { this.input.stepUp(); if (this.value !== this.input.value) { this.value = this.input.value; } } /** Decrements the value of a numeric input type by the value of the step attribute. */ stepDown() { this.input.stepDown(); if (this.value !== this.input.value) { this.value = this.input.value; } } /** Checks for validity but does not show the browser's validation message. */ checkValidity() { return this.input.checkValidity(); } /** Checks for validity and shows the browser's validation message if the control is invalid. */ reportValidity() { return this.input.reportValidity(); } /** Sets a custom validation message. Pass an empty string to restore validity. */ setCustomValidity(message: string) { this.input.setCustomValidity(message); this.formControlController.updateValidity(); } render() { const hasLabelSlot = this.hasSlotController.test('label'); const hasHelpTextSlot = this.hasSlotController.test('help-text'); const hasLabel = this.label ? true : !!hasLabelSlot; const hasHelpText = this.helpText ? true : !!hasHelpTextSlot; const hasClearIcon = this.clearable && !this.disabled && !this.readonly && (typeof this.value === 'number' || this.value.length > 0); return html`
${ hasClearIcon ? html` ` : '' } ${ this.passwordToggle && !this.disabled ? html` ` : '' }
${this.helpText}
`; } } declare global { interface HTMLElementTagNameMap { 'sl-input': SlInput; } }