mirror of
https://github.com/shoelace-style/webawesome.git
synced 2026-01-12 04:09:12 +00:00
405 lines
14 KiB
TypeScript
405 lines
14 KiB
TypeScript
import { classMap } from 'lit/directives/class-map.js';
|
|
import { customElement, property, query, state } from 'lit/decorators.js';
|
|
import { HasSlotController } from '../../internal/slot.js';
|
|
import { html } from 'lit';
|
|
import { ifDefined } from 'lit/directives/if-defined.js';
|
|
import { live } from 'lit/directives/live.js';
|
|
import { MirrorValidator } from '../../internal/validators/mirror-validator.js';
|
|
import { WaBlurEvent } from '../../events/blur.js';
|
|
import { WaChangeEvent } from '../../events/change.js';
|
|
import { WaFocusEvent } from '../../events/focus.js';
|
|
import { WaInputEvent } from '../../events/input.js';
|
|
import { watch } from '../../internal/watch.js';
|
|
import { WebAwesomeFormAssociatedElement } from '../../internal/webawesome-element.js';
|
|
import formControlStyles from '../../styles/shadow/form-control.css';
|
|
import styles from './textarea.css';
|
|
|
|
/**
|
|
* @summary Textareas collect data from the user and allow multiple lines of text.
|
|
* @documentation https://backers.webawesome.com/docs/components/textarea
|
|
* @status stable
|
|
* @since 2.0
|
|
*
|
|
* @slot label - The textarea's label. Alternatively, you can use the `label` attribute.
|
|
* @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
|
|
*
|
|
* @event wa-blur - Emitted when the control loses focus.
|
|
* @event wa-change - Emitted when an alteration to the control's value is committed by the user.
|
|
* @event wa-focus - Emitted when the control gains focus.
|
|
* @event wa-input - Emitted when the control receives input.
|
|
* @event wa-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
*
|
|
* @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 textarea - The internal `<textarea>` control.
|
|
*
|
|
* @cssproperty --background-color - The textarea's background color.
|
|
* @cssproperty --border-color - The color of the textarea's borders.
|
|
* @cssproperty --border-radius - The border radius of the textarea's corners.
|
|
* @cssproperty --border-style - The style of the textarea's borders.
|
|
* @cssproperty --border-width - The width of the textarea's borders.
|
|
* @cssproperty --box-shadow - The shadow effects around the edges of the textarea.
|
|
*/
|
|
@customElement('wa-textarea')
|
|
export default class WaTextarea extends WebAwesomeFormAssociatedElement {
|
|
static shadowStyle = [formControlStyles, styles];
|
|
static get validators() {
|
|
return [...super.validators, MirrorValidator()];
|
|
}
|
|
|
|
assumeInteractionOn = ['wa-blur', 'wa-input'];
|
|
private readonly hasSlotController = new HasSlotController(this, 'help-text', 'label');
|
|
private resizeObserver: ResizeObserver;
|
|
|
|
@query('.textarea__control') input: HTMLTextAreaElement;
|
|
@query('.textarea__size-adjuster') sizeAdjuster: HTMLTextAreaElement;
|
|
|
|
@state() private hasFocus = false;
|
|
@property() title = ''; // make reactive to pass through
|
|
|
|
/** The name of the textarea, submitted as a name/value pair with form data. */
|
|
@property({ reflect: true }) name: string | null = null;
|
|
|
|
private _value: string = '';
|
|
|
|
/** The current value of the input, submitted as a name/value pair with form data. */
|
|
get value() {
|
|
if (this.valueHasChanged) {
|
|
return this._value;
|
|
}
|
|
|
|
return this._value || this.defaultValue;
|
|
}
|
|
|
|
@state()
|
|
set value(val: string) {
|
|
if (this._value === val) {
|
|
return;
|
|
}
|
|
|
|
this.valueHasChanged = true;
|
|
this._value = val;
|
|
}
|
|
|
|
/** The default value of the form control. Primarily used for resetting the form control. */
|
|
@property({ attribute: 'value', reflect: true }) defaultValue: string = this.getAttribute('value') ?? '';
|
|
|
|
/** The textarea's size. */
|
|
@property({ reflect: true }) size: 'small' | 'medium' | 'large' = 'medium';
|
|
|
|
/** Draws a filled textarea. */
|
|
@property({ type: Boolean, reflect: true }) filled = false;
|
|
|
|
/** The textarea's label. If you need to display HTML, use the `label` slot instead. */
|
|
@property() label = '';
|
|
|
|
/** The textarea's help text. If you need to display HTML, use the `help-text` slot instead. */
|
|
@property({ attribute: 'help-text' }) helpText = '';
|
|
|
|
/** Placeholder text to show as a hint when the input is empty. */
|
|
@property() placeholder = '';
|
|
|
|
/** The number of rows to display by default. */
|
|
@property({ type: Number }) rows = 4;
|
|
|
|
/** Controls how the textarea can be resized. */
|
|
@property() resize: 'none' | 'vertical' | 'auto' = 'vertical';
|
|
|
|
/** Disables the textarea. */
|
|
@property({ type: Boolean }) disabled = false;
|
|
|
|
/** Makes the textarea readonly. */
|
|
@property({ type: Boolean, reflect: true }) readonly = false;
|
|
|
|
/**
|
|
* By default, form controls are associated with the nearest containing `<form>` 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 = null;
|
|
|
|
/** Makes the textarea a required field. */
|
|
@property({ type: Boolean, reflect: true }) required = 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;
|
|
|
|
/** 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: string;
|
|
|
|
/**
|
|
* 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 textarea. */
|
|
@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';
|
|
|
|
/**
|
|
* Used for SSR. If you're slotting in a `label` element, make sure to set this to `true`.
|
|
*/
|
|
@property({ attribute: 'with-label', type: Boolean }) withLabel = false;
|
|
|
|
/**
|
|
* Used for SSR. If you're slotting in a `help-text` element, make sure to set this to `true`.
|
|
*/
|
|
@property({ attribute: 'with-help-text', type: Boolean }) withHelpText = false;
|
|
|
|
connectedCallback() {
|
|
super.connectedCallback();
|
|
|
|
this.resizeObserver = new ResizeObserver(() => this.setTextareaHeight());
|
|
|
|
this.updateComplete.then(() => {
|
|
this.setTextareaHeight();
|
|
this.resizeObserver.observe(this.input);
|
|
|
|
if (this.didSSR && this.input && this.value !== this.input.value) {
|
|
const value = this.input.value;
|
|
|
|
this.value = value;
|
|
}
|
|
});
|
|
}
|
|
|
|
disconnectedCallback() {
|
|
super.disconnectedCallback();
|
|
if (this.input) {
|
|
this.resizeObserver?.unobserve(this.input);
|
|
}
|
|
}
|
|
|
|
private handleBlur() {
|
|
this.hasFocus = false;
|
|
this.dispatchEvent(new WaBlurEvent());
|
|
this.checkValidity();
|
|
}
|
|
|
|
private handleChange() {
|
|
this.value = this.input.value;
|
|
this.setTextareaHeight();
|
|
this.dispatchEvent(new WaChangeEvent());
|
|
this.checkValidity();
|
|
}
|
|
|
|
private handleFocus() {
|
|
this.hasFocus = true;
|
|
this.dispatchEvent(new WaFocusEvent());
|
|
}
|
|
|
|
private handleInput() {
|
|
this.value = this.input.value;
|
|
this.dispatchEvent(new WaInputEvent());
|
|
}
|
|
|
|
private setTextareaHeight() {
|
|
if (this.resize === 'auto') {
|
|
// This prevents layout shifts. We use `clientHeight` instead of `scrollHeight` to account for if the `<textarea>` has a max-height set on it. In my tests, this has worked fine. Im not aware of any edge cases. [Konnor]
|
|
this.sizeAdjuster.style.height = `${this.input.clientHeight}px`;
|
|
this.input.style.height = 'auto';
|
|
this.input.style.height = `${this.input.scrollHeight}px`;
|
|
} else {
|
|
this.input.style.height = '';
|
|
}
|
|
}
|
|
|
|
@watch('rows', { waitUntilFirstUpdate: true })
|
|
handleRowsChange() {
|
|
this.setTextareaHeight();
|
|
}
|
|
|
|
@watch('value', { waitUntilFirstUpdate: true })
|
|
async handleValueChange() {
|
|
await this.updateComplete;
|
|
this.checkValidity();
|
|
this.setTextareaHeight();
|
|
}
|
|
|
|
/** Sets focus on the textarea. */
|
|
focus(options?: FocusOptions) {
|
|
this.input.focus(options);
|
|
}
|
|
|
|
/** Removes focus from the textarea. */
|
|
blur() {
|
|
this.input.blur();
|
|
}
|
|
|
|
/** Selects all the text in the textarea. */
|
|
select() {
|
|
this.input.select();
|
|
}
|
|
|
|
/** Gets or sets the textarea's scroll position. */
|
|
scrollPosition(position?: { top?: number; left?: number }): { top: number; left: number } | undefined {
|
|
if (position) {
|
|
if (typeof position.top === 'number') this.input.scrollTop = position.top;
|
|
if (typeof position.left === 'number') this.input.scrollLeft = position.left;
|
|
return undefined;
|
|
}
|
|
|
|
return {
|
|
top: this.input.scrollTop,
|
|
left: this.input.scrollTop
|
|
};
|
|
}
|
|
|
|
/** 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'
|
|
) {
|
|
const selectionStart = start ?? this.input.selectionStart;
|
|
const selectionEnd = end ?? this.input.selectionEnd;
|
|
|
|
this.input.setRangeText(replacement, selectionStart, selectionEnd, selectMode);
|
|
|
|
if (this.value !== this.input.value) {
|
|
this.value = this.input.value;
|
|
this.setTextareaHeight();
|
|
}
|
|
}
|
|
|
|
formResetCallback() {
|
|
this.value = this.defaultValue;
|
|
|
|
super.formResetCallback();
|
|
}
|
|
|
|
render() {
|
|
const hasLabelSlot = this.hasUpdated ? this.hasSlotController.test('label') : this.withLabel;
|
|
const hasHelpTextSlot = this.hasUpdated ? this.hasSlotController.test('help-text') : this.withHelpText;
|
|
const hasLabel = this.label ? true : !!hasLabelSlot;
|
|
const hasHelpText = this.helpText ? true : !!hasHelpTextSlot;
|
|
|
|
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({
|
|
textarea: true,
|
|
'textarea--small': this.size === 'small',
|
|
'textarea--medium': this.size === 'medium',
|
|
'textarea--large': this.size === 'large',
|
|
'textarea--standard': !this.filled,
|
|
'textarea--filled': this.filled,
|
|
'textarea--disabled': this.disabled,
|
|
'textarea--focused': this.hasFocus,
|
|
'textarea--empty': !this.value,
|
|
'textarea--resize-none': this.resize === 'none',
|
|
'textarea--resize-vertical': this.resize === 'vertical',
|
|
'textarea--resize-auto': this.resize === 'auto'
|
|
})}
|
|
>
|
|
<textarea
|
|
part="textarea"
|
|
id="input"
|
|
class="textarea__control"
|
|
title=${this.title /* An empty title prevents browser validation tooltips from appearing on hover */}
|
|
name=${ifDefined(this.name)}
|
|
.value=${live(this.value)}
|
|
?disabled=${this.disabled}
|
|
?readonly=${this.readonly}
|
|
?required=${this.required}
|
|
placeholder=${ifDefined(this.placeholder)}
|
|
rows=${ifDefined(this.rows)}
|
|
minlength=${ifDefined(this.minlength)}
|
|
maxlength=${ifDefined(this.maxlength)}
|
|
autocapitalize=${ifDefined(this.autocapitalize)}
|
|
autocorrect=${ifDefined(this.autocorrect)}
|
|
?autofocus=${this.autofocus}
|
|
spellcheck=${ifDefined(this.spellcheck)}
|
|
enterkeyhint=${ifDefined(this.enterkeyhint)}
|
|
inputmode=${ifDefined(this.inputmode)}
|
|
aria-describedby="help-text"
|
|
@change=${this.handleChange}
|
|
@input=${this.handleInput}
|
|
@focus=${this.handleFocus}
|
|
@blur=${this.handleBlur}
|
|
></textarea>
|
|
|
|
<!-- This "adjuster" exists to prevent layout shifting. https://github.com/shoelace-style/shoelace/issues/2180 -->
|
|
<div part="textarea-adjuster" class="textarea__size-adjuster" ?hidden=${this.resize !== 'auto'}></div>
|
|
</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 {
|
|
'wa-textarea': WaTextarea;
|
|
}
|
|
}
|