@synergy-design-system/components
Version:
This package provides the base of the Synergy Design System as native web components. It uses [lit](https://www.lit.dev) and parts of [shoelace](https://shoelace.style/). Synergy officially supports the latest two versions of all major browsers (as define
139 lines (138 loc) • 6.66 kB
TypeScript
/**
* ---------------------------------------------------------------------
* 🔒 AUTOGENERATED BY VENDORISM
* Removing this comment will prevent it from being managed by it.
* ---------------------------------------------------------------------
*/
import SynergyElement from '../../internal/synergy-element.js';
import type { CSSResultGroup } from 'lit';
import type { SynergyFormControl } from '../../internal/synergy-element.js';
/**
* @summary Textareas collect data from the user and allow multiple lines of text.
* @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-textarea--docs
* @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 syn-blur - Emitted when the control loses focus.
* @event syn-change - Emitted when an alteration to the control's value is committed by the user.
* @event syn-focus - Emitted when the control gains focus.
* @event syn-input - Emitted when the control receives input.
* @event syn-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.
*/
export default class SynTextarea extends SynergyElement implements SynergyFormControl {
static styles: CSSResultGroup;
private readonly formControlController;
private readonly hasSlotController;
private resizeObserver;
input: HTMLTextAreaElement;
sizeAdjuster: HTMLTextAreaElement;
private hasFocus;
title: string;
/** The name of the textarea, submitted as a name/value pair with form data. */
name: string;
/** The current value of the textarea, submitted as a name/value pair with form data. */
value: string;
/** The textarea's size. */
size: 'small' | 'medium' | 'large';
/** The textarea's label. If you need to display HTML, use the `label` slot instead. */
label: string;
/** The textarea's help text. If you need to display HTML, use the `help-text` slot instead. */
helpText: string;
/** Placeholder text to show as a hint when the input is empty. */
placeholder: string;
/** The number of rows to display by default. */
rows: number;
/** Controls how the textarea can be resized. */
resize: 'none' | 'vertical' | 'auto';
/** Disables the textarea. */
disabled: boolean;
/** Makes the textarea readonly. */
readonly: boolean;
/**
* 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.
*/
form: string;
/** Makes the textarea a required field. */
required: boolean;
/** The minimum length of input that will be considered valid. */
minlength: number;
/** The maximum length of input that will be considered valid. */
maxlength: number;
/** Controls whether and how text input is automatically capitalized as it is entered by the user. */
autocapitalize: 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters';
/** Indicates whether the browser's autocorrect feature is on or off. */
autocorrect: boolean;
/**
* 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.
*/
autocomplete: string;
/** Indicates that the input should receive focus on page load. */
autofocus: boolean;
/** Used to customize the label or icon of the Enter key on virtual keyboards. */
enterkeyhint: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
/** Enables spell checking on the textarea. */
spellcheck: boolean;
/**
* Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual
* keyboard on supportive devices.
*/
inputmode: 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url';
/** The default value of the form control. Primarily used for resetting the form control. */
defaultValue: string;
/** Gets the validity state object */
get validity(): ValidityState;
/** Gets the validation message */
get validationMessage(): string;
connectedCallback(): void;
firstUpdated(): void;
disconnectedCallback(): void;
private handleBlur;
private handleChange;
private handleFocus;
private handleInput;
private handleInvalid;
private setTextareaHeight;
handleDisabledChange(): void;
handleRowsChange(): void;
handleValueChange(): Promise<void>;
/** Sets focus on the textarea. */
focus(options?: FocusOptions): void;
/** Removes focus from the textarea. */
blur(): void;
/** Selects all the text in the textarea. */
select(): void;
/** Gets or sets the textarea's scroll position. */
scrollPosition(position?: {
top?: number;
left?: number;
}): {
top: number;
left: number;
} | undefined;
/** Sets the start and end positions of the text selection (0-based). */
setSelectionRange(selectionStart: number, selectionEnd: number, selectionDirection?: 'forward' | 'backward' | 'none'): void;
/** Replaces a range of text with a new string. */
setRangeText(replacement: string, start?: number, end?: number, selectMode?: 'select' | 'start' | 'end' | 'preserve'): void;
/** Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid. */
checkValidity(): boolean;
/** Gets the associated form, if one exists. */
getForm(): HTMLFormElement | null;
/** Checks for validity and shows the browser's validation message if the control is invalid. */
reportValidity(): boolean;
/** Sets a custom validation message. Pass an empty string to restore validity. */
setCustomValidity(message: string): void;
render(): import("lit").TemplateResult<1>;
}