mirror of
https://github.com/shoelace-style/webawesome.git
synced 2026-01-12 04:09:12 +00:00
490 lines
17 KiB
TypeScript
490 lines
17 KiB
TypeScript
import { html } from 'lit';
|
|
import { customElement, property, query, state } from 'lit/decorators.js';
|
|
import { classMap } from 'lit/directives/class-map.js';
|
|
import { ifDefined } from 'lit/directives/if-defined.js';
|
|
import { live } from 'lit/directives/live.js';
|
|
import { defaultValue } from '../../internal/default-value';
|
|
import { emit } from '../../internal/event';
|
|
import { FormSubmitController } from '../../internal/form';
|
|
import ShoelaceElement from '../../internal/shoelace-element';
|
|
import { HasSlotController } from '../../internal/slot';
|
|
import { watch } from '../../internal/watch';
|
|
import { LocalizeController } from '../../utilities/localize';
|
|
import '../icon/icon';
|
|
import styles from './input.styles';
|
|
import type { CSSResultGroup } from 'lit';
|
|
|
|
// It's currently impossible to hide Firefox's built-in clear icon when using <input type="date|time">, 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');
|
|
|
|
/**
|
|
* @since 2.0
|
|
* @status stable
|
|
*
|
|
* @dependency sl-icon
|
|
*
|
|
* @slot label - The input's label. Alternatively, you can use the `label` attribute.
|
|
* @slot prefix - Used to prepend an icon or similar element to the input.
|
|
* @slot suffix - Used to append an 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 - Help text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
|
|
*
|
|
* @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-input - Emitted when the control receives input and its value changes.
|
|
* @event sl-focus - Emitted when the control gains focus.
|
|
* @event sl-blur - Emitted when the control loses focus.
|
|
*
|
|
* @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 internal wrapper.
|
|
* @csspart input - The input control.
|
|
* @csspart prefix - The input prefix container.
|
|
* @csspart clear-button - The clear button.
|
|
* @csspart password-toggle-button - The password toggle button.
|
|
* @csspart suffix - The input suffix container.
|
|
*/
|
|
@customElement('sl-input')
|
|
export default class SlInput extends ShoelaceElement {
|
|
static styles: CSSResultGroup = styles;
|
|
|
|
@query('.input__control') input: HTMLInputElement;
|
|
|
|
private readonly formSubmitController = new FormSubmitController(this);
|
|
private readonly hasSlotController = new HasSlotController(this, 'help-text', 'label');
|
|
private readonly localize = new LocalizeController(this);
|
|
|
|
@state() private hasFocus = false;
|
|
@state() private isPasswordVisible = false;
|
|
|
|
/** The input's type. */
|
|
@property({ reflect: true }) type:
|
|
| 'date'
|
|
| 'datetime-local'
|
|
| 'email'
|
|
| 'number'
|
|
| 'password'
|
|
| 'search'
|
|
| 'tel'
|
|
| 'text'
|
|
| 'time'
|
|
| 'url' = 'text';
|
|
|
|
/** The input's size. */
|
|
@property({ reflect: true }) size: 'small' | 'medium' | 'large' = 'medium';
|
|
|
|
/** The input's name attribute. */
|
|
@property() name: string;
|
|
|
|
/** The input's value attribute. */
|
|
@property() value = '';
|
|
|
|
/** Gets or sets the default value used to reset this element. The initial value corresponds to the one originally specified in the HTML that created this element. */
|
|
@defaultValue()
|
|
defaultValue = '';
|
|
|
|
/** 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, you can use the `label` slot instead. */
|
|
@property() label = '';
|
|
|
|
/** The input's help text. If you need to display HTML, you can use the `help-text` slot instead. */
|
|
@property({ attribute: 'help-text' }) helpText = '';
|
|
|
|
/** Adds a clear button when the input is populated. */
|
|
@property({ type: Boolean }) clearable = false;
|
|
|
|
/** Adds a password toggle button to password inputs. */
|
|
@property({ attribute: 'toggle-password', type: Boolean }) togglePassword = false;
|
|
|
|
/** Hides the browser's built-in increment/decrement spin buttons for number inputs. */
|
|
@property({ attribute: 'no-spin-buttons', type: Boolean }) noSpinButtons = false;
|
|
|
|
/** The input's placeholder text. */
|
|
@property() placeholder: string;
|
|
|
|
/** Disables the input. */
|
|
@property({ type: Boolean, reflect: true }) disabled = false;
|
|
|
|
/** Makes the input readonly. */
|
|
@property({ type: Boolean, reflect: true }) readonly = false;
|
|
|
|
/** 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. */
|
|
@property() min: number | string;
|
|
|
|
/** The input's maximum value. */
|
|
@property() max: number | string;
|
|
|
|
/**
|
|
* Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is
|
|
* implied, allowing any numeric value.
|
|
*/
|
|
@property() step: number | 'any';
|
|
|
|
/** A pattern to validate input against. */
|
|
@property() pattern: string;
|
|
|
|
/** Makes the input a required field. */
|
|
@property({ type: Boolean, reflect: true }) required = false;
|
|
|
|
/**
|
|
* This will be true when the control is in an invalid state. Validity is determined by props such as `type`,
|
|
* `required`, `minlength`, `maxlength`, and `pattern` using the browser's constraint validation API.
|
|
*/
|
|
@property({ type: Boolean, reflect: true }) invalid = false;
|
|
|
|
/** The input's autocapitalize attribute. */
|
|
@property() autocapitalize: 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters';
|
|
|
|
/** The input's autocorrect attribute. */
|
|
@property() autocorrect: string;
|
|
|
|
/** The input's autocomplete attribute. */
|
|
@property() autocomplete: string;
|
|
|
|
/** The input's autofocus attribute. */
|
|
@property({ type: Boolean }) autofocus: boolean;
|
|
|
|
/**
|
|
* The input's enterkeyhint attribute. This can be 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 }) spellcheck: boolean;
|
|
|
|
/** The input's inputmode attribute. */
|
|
@property() inputmode: 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url';
|
|
|
|
/** Gets or sets the current value as a `Date` object. Only valid when `type` is `date`. */
|
|
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. */
|
|
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.invalid = !this.input.checkValidity();
|
|
}
|
|
|
|
/** 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' = 'preserve'
|
|
) {
|
|
this.input.setRangeText(replacement, start, end, selectMode);
|
|
|
|
if (this.value !== this.input.value) {
|
|
this.value = this.input.value;
|
|
emit(this, 'sl-input');
|
|
emit(this, 'sl-change');
|
|
}
|
|
}
|
|
|
|
/** 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. If `message` is not empty, the field will be considered invalid. */
|
|
setCustomValidity(message: string) {
|
|
this.input.setCustomValidity(message);
|
|
this.invalid = !this.input.checkValidity();
|
|
}
|
|
|
|
handleBlur() {
|
|
this.hasFocus = false;
|
|
emit(this, 'sl-blur');
|
|
}
|
|
|
|
handleChange() {
|
|
this.value = this.input.value;
|
|
emit(this, 'sl-change');
|
|
}
|
|
|
|
handleClearClick(event: MouseEvent) {
|
|
this.value = '';
|
|
emit(this, 'sl-clear');
|
|
emit(this, 'sl-input');
|
|
emit(this, 'sl-change');
|
|
this.input.focus();
|
|
|
|
event.stopPropagation();
|
|
}
|
|
|
|
@watch('disabled', { waitUntilFirstUpdate: true })
|
|
handleDisabledChange() {
|
|
// Disabled form controls are always valid, so we need to recheck validity when the state changes
|
|
this.input.disabled = this.disabled;
|
|
this.invalid = !this.input.checkValidity();
|
|
}
|
|
|
|
@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.invalid = !this.input.checkValidity();
|
|
}
|
|
|
|
handleFocus() {
|
|
this.hasFocus = true;
|
|
emit(this, 'sl-focus');
|
|
}
|
|
|
|
handleInput() {
|
|
this.value = this.input.value;
|
|
emit(this, 'sl-input');
|
|
}
|
|
|
|
handleInvalid() {
|
|
this.invalid = true;
|
|
}
|
|
|
|
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(() => {
|
|
if (!event.defaultPrevented) {
|
|
this.formSubmitController.submit();
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
handlePasswordToggle() {
|
|
this.isPasswordVisible = !this.isPasswordVisible;
|
|
}
|
|
|
|
@watch('value', { waitUntilFirstUpdate: true })
|
|
handleValueChange() {
|
|
this.invalid = !this.input.checkValidity();
|
|
}
|
|
|
|
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`
|
|
<div
|
|
part="form-control"
|
|
class=${classMap({
|
|
'form-control': true,
|
|
'form-control--small': this.size === 'small',
|
|
'form-control--medium': this.size === 'medium',
|
|
'form-control--large': this.size === 'large',
|
|
'form-control--has-label': hasLabel,
|
|
'form-control--has-help-text': hasHelpText
|
|
})}
|
|
>
|
|
<label
|
|
part="form-control-label"
|
|
class="form-control__label"
|
|
for="input"
|
|
aria-hidden=${hasLabel ? 'false' : 'true'}
|
|
>
|
|
<slot name="label">${this.label}</slot>
|
|
</label>
|
|
|
|
<div part="form-control-input" class="form-control-input">
|
|
<div
|
|
part="base"
|
|
class=${classMap({
|
|
input: true,
|
|
|
|
// Sizes
|
|
'input--small': this.size === 'small',
|
|
'input--medium': this.size === 'medium',
|
|
'input--large': this.size === 'large',
|
|
|
|
// States
|
|
'input--pill': this.pill,
|
|
'input--standard': !this.filled,
|
|
'input--filled': this.filled,
|
|
'input--disabled': this.disabled,
|
|
'input--focused': this.hasFocus,
|
|
'input--empty': !this.value,
|
|
'input--invalid': this.invalid,
|
|
'input--no-spin-buttons': this.noSpinButtons,
|
|
'input--is-firefox': isFirefox
|
|
})}
|
|
>
|
|
<span part="prefix" class="input__prefix">
|
|
<slot name="prefix"></slot>
|
|
</span>
|
|
|
|
<input
|
|
part="input"
|
|
id="input"
|
|
class="input__control"
|
|
type=${this.type === 'password' && this.isPasswordVisible ? 'text' : this.type}
|
|
name=${ifDefined(this.name)}
|
|
?disabled=${this.disabled}
|
|
?readonly=${this.readonly}
|
|
?required=${this.required}
|
|
placeholder=${ifDefined(this.placeholder)}
|
|
minlength=${ifDefined(this.minlength)}
|
|
maxlength=${ifDefined(this.maxlength)}
|
|
min=${ifDefined(this.min)}
|
|
max=${ifDefined(this.max)}
|
|
step=${ifDefined(this.step as number)}
|
|
.value=${live(this.value)}
|
|
autocapitalize=${ifDefined(this.type === 'password' ? 'off' : this.autocapitalize)}
|
|
autocomplete=${ifDefined(this.type === 'password' ? 'off' : this.autocomplete)}
|
|
autocorrect=${ifDefined(this.type === 'password' ? 'off' : this.autocorrect)}
|
|
?autofocus=${this.autofocus}
|
|
spellcheck=${ifDefined(this.spellcheck)}
|
|
pattern=${ifDefined(this.pattern)}
|
|
enterkeyhint=${ifDefined(this.enterkeyhint)}
|
|
inputmode=${ifDefined(this.inputmode)}
|
|
aria-describedby="help-text"
|
|
aria-invalid=${this.invalid ? 'true' : 'false'}
|
|
@change=${this.handleChange}
|
|
@input=${this.handleInput}
|
|
@invalid=${this.handleInvalid}
|
|
@keydown=${this.handleKeyDown}
|
|
@focus=${this.handleFocus}
|
|
@blur=${this.handleBlur}
|
|
/>
|
|
|
|
${hasClearIcon
|
|
? html`
|
|
<button
|
|
part="clear-button"
|
|
class="input__clear"
|
|
type="button"
|
|
aria-label=${this.localize.term('clearEntry')}
|
|
@click=${this.handleClearClick}
|
|
tabindex="-1"
|
|
>
|
|
<slot name="clear-icon">
|
|
<sl-icon name="x-circle-fill" library="system"></sl-icon>
|
|
</slot>
|
|
</button>
|
|
`
|
|
: ''}
|
|
${this.togglePassword && !this.disabled
|
|
? html`
|
|
<button
|
|
part="password-toggle-button"
|
|
class="input__password-toggle"
|
|
type="button"
|
|
aria-label=${this.localize.term(this.isPasswordVisible ? 'hidePassword' : 'showPassword')}
|
|
@click=${this.handlePasswordToggle}
|
|
tabindex="-1"
|
|
>
|
|
${this.isPasswordVisible
|
|
? html`
|
|
<slot name="show-password-icon">
|
|
<sl-icon name="eye-slash" library="system"></sl-icon>
|
|
</slot>
|
|
`
|
|
: html`
|
|
<slot name="hide-password-icon">
|
|
<sl-icon name="eye" library="system"></sl-icon>
|
|
</slot>
|
|
`}
|
|
</button>
|
|
`
|
|
: ''}
|
|
|
|
<span part="suffix" class="input__suffix">
|
|
<slot name="suffix"></slot>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
<div
|
|
part="form-control-help-text"
|
|
id="help-text"
|
|
class="form-control__help-text"
|
|
aria-hidden=${hasHelpText ? 'false' : 'true'}
|
|
>
|
|
<slot name="help-text">${this.helpText}</slot>
|
|
</div>
|
|
</div>
|
|
`;
|
|
}
|
|
}
|
|
|
|
declare global {
|
|
interface HTMLElementTagNameMap {
|
|
'sl-input': SlInput;
|
|
}
|
|
}
|