@quartzds/core 1.0.0-beta.12 → 1.0.0-beta.120

package/dist/types/components/textarea/textarea.d.ts

@@ -1,8 +1,9 @@
 import type { ComponentInterface } from '../../stencil-public-runtime';
-import type { AutoCapitalize, EnterKeyHint, InputMode, SelectDirection, Value } from '../controls';
+import type { EnterKeyHint, InputMode, Value } from '../controls';
+import type { Size, Status } from '../shared';
 export type TextAreaAutoComplete = 'off' | 'on';
-export type TextAreaSize = 'large' | 'small' | 'standard';
-export type Wrap = 'hard' | 'off' | 'soft';
+export type Wrap = 'off' | 'soft';
+export type TextAreaStatus = Exclude<Status, 'info'>;
 /**
  * The `<qds-textarea>` element represents a multi-line plain-text editing
  * control, useful when you want to allow users to enter a sizeable amount of
@@ -11,302 +12,296 @@ export type Wrap = 'hard' | 'off' | 'soft';
  * @see https://quartz.se.com/build/components/textarea
  */
 export declare class TextArea implements ComponentInterface {
-  /**
-   * Defines if the textarea is in an invalid state. Validity is determined by
-   * attributes such as `required`, `minlength`, and `maxlength` using
-   * [constraint validation][].
-   *
-   * [constraint validation]: https://developer.mozilla.org/docs/Web/Guide/HTML/Constraint_validation
-   */
-  invalid?: boolean;
-  /**
-   * The textarea's size.
-   *
-   * > **_NOTE:_** The native [`size` HTML attribute][] is not supported. CSS
-   * `width` should be used instead if this functionality is needed.
-   *
-   * [`size` HTML attribute]: https://developer.mozilla.org/docs/Web/HTML/Attributes/size
-   */
-  readonly size: TextAreaSize;
-  /**
-   * Controls whether and how input is automatically capitalized as it is
-   * entered/edited by the user. Possible values:
-   *
-   * - `"off"` or `"none"`: No auto-capitalization is applied (all letters
-   * default to lowercase).
-   * - `"on"` or `"sentences"`: The first letter of each sentence defaults to a
-   * capital letter; all other letters default to lowercase.
-   * - `"words"`: The first letter of each word defaults to a capital letter;
-   * all other letters default to lowercase.
-   * - `"characters"`: All letters default to uppercase.
-   *
-   * @webnative
-   */
-  readonly autoCapitalize?: AutoCapitalize;
-  /**
-   * Indicates whether the value of the textarea can be automatically completed
-   * by the browser. Possible values:
-   *
-   * `off`: The user must explicitly enter a value into this field for every
-   * use, or the document provides its own auto-completion method; the browser
-   * does not automatically complete the entry.
-   * `on`: The browser can automatically complete the value based on values
-   * that the user has entered during previous uses.
-   *
-   * If the `autocomplete` attribute is not specified on a `<qds-textarea>`
-   * element, then the browser uses the `autocomplete` attribute value of the
-   * `<qds-textarea>` element's form owner. The form owner is either the
-   * [`<form>`][] element that this `<qds-textarea>` element is a descendant of
-   * or the form element whose `id` is specified by the `form` attribute of the
-   * `qds-textarea` element. For more information, see the [`autocomplete`]
-   * attribute in [`<form>`][].
-   *
-   * [`<form>`]: https://developer.mozilla.org/docs/Web/HTML/Element/form
-   * [`autocomplete`]: https://developer.mozilla.org/docs/Web/HTML/Element/form#autocomplete
-   *
-   * @webnative
-   */
-  readonly autoComplete?: TextAreaAutoComplete;
-  /**
-   * Specify whether the input should have focus when the page loads.
-   *
-   * @webnative
-   */
-  readonly autoFocus?: boolean;
-  /**
-   * The visible width of the text control, in average character widths. If it
-   * is specified, it must be a positive integer. If it is not specified, the
-   * default value is `20`.
-   *
-   * @webnative
-   */
-  readonly cols?: number;
-  /**
-   * Prevents the input from being interacted with: it cannot be pressed or
-   * focused.
-   *
-   * @webnative
-   */
-  disabled?: boolean;
-  /**
-   * What action label (or icon) to present for the enter key on virtual
-   * keyboards. Possible values:
-   *
-   * - `"done"`: Typically meaning there is nothing more to input and the input
-   * method editor (IME) will be closed.
-   * - `"enter"`:	Typically inserting a new line.
-   * - `"go"`: 	Typically meaning to take the user to the target of the text
-   * they typed.
-   * - `"next"`: 	Typically taking the user to the next field that will accept
-   * text.
-   * - `"previous"`: Typically taking the user to the previous field that will
-   * accept text.
-   * - `"search"`: Typically taking the user to the results of searching for
-   * the text they have typed.
-   * - `"send"`: Typically delivering the text to its target.
-   *
-   * @webnative
-   */
-  readonly enterkeyhint?: EnterKeyHint;
-  /**
-   * The [`<form>`][] element to associate the input with (its form owner).
-   *
-   * The value of this attribute must be the id of a `<form>` in the same
-   * document. If this attribute is not set, the `<qds-textarea>` is associated
-   * with its ancestor `<form>` element, if any.
-   *
-   * This attribute lets you associate `<qds-textarea>` elements to `<form>`s
-   * anywhere in the document, not just inside a `<form>`. It can also override
-   * an ancestor `<form>` element.
-   *
-   * [`<form>`]: https://developer.mozilla.org/docs/Web/HTML/Element/form
-   *
-   * @webnative
-   */
-  readonly form?: string;
-  /**
-   * Provide a hint to browsers as to the type of virtual keyboard
-   * configuration to use when editing this element or its contents.
-   *
-   * @webnative
-   */
-  readonly inputmode?: InputMode;
-  /**
-   * The maximum number of characters (as UTF-16 code units) the user can enter
-   * into the textarea. This must be an non-negative integer value. If no
-   * `maxlength` is specified, or an invalid value is specified, the textarea
-   * has no maximum length.
-   *
-   * The textarea will fail [constraint validation][] if the length of the text
-   * entered into the field is greater than `maxlength` UTF-16 code units long.
-   * By default, browsers prevent users from entering more characters than
-   * allowed by the `maxlength` attribute. See [Client-side validation][] for
-   * more information.
-   *
-   * [constraint validation]: https://developer.mozilla.org/docs/Web/Guide/HTML/Constraint_validation
-   * [Client-side validation]: https://developer.mozilla.org/docs/Web/HTML/Element/input#client-side_validation
-   *
-   * @webnative
-   */
-  readonly maxLength?: number;
-  /**
-   * The minimum number of characters (as UTF-16 code units) the user can enter
-   * into the textarea. This must be an non-negative integer value smaller than
-   * or equal to the value specified by `maxlength`. If no `minlength` is
-   * specified, or an invalid value is specified, the textarea has no minimum
-   * length.
-   *
-   * The textarea will fail [constraint validation][] if the length of the text
-   * entered into the field is fewer than `minlength` UTF-16 code units long,
-   * preventing form submission. See [Client-side validation][] for more
-   * information.
-   *
-   * [constraint validation]: https://developer.mozilla.org/docs/Web/Guide/HTML/Constraint_validation
-   * [Client-side validation]: https://developer.mozilla.org/docs/Web/HTML/Element/input#client-side_validation
-   *
-   * @webnative
-   */
-  readonly minLength?: number;
-  /**
-   * The name of the control, which is submitted with the form data. An
-   * incrementing textarea ID is used by default.
-   *
-   * @webnative
-   */
-  readonly name: string;
-  /**
-   * Text that appears in the textarea when it has no value set.
-   *
-   * @webnative
-   */
-  readonly placeholder?: string;
-  /**
-   * The value of the textarea cannot be edited.
-   *
-   * @webnative
-   */
-  readonly readOnly?: boolean;
-  /**
-   * A value must be specified for the textarea before the owning form can be
-   * submitted.
-   *
-   * See [Client-side validation][] and the [HTML attribute: `required`][] for
-   * more information.
-   *
-   * [Client-side validation]: https://developer.mozilla.org/docs/Web/HTML/Element/input#client-side_validation
-   * [HTML attribute: `required`]: https://developer.mozilla.org/docs/Web/HTML/Attributes/required
-   *
-   * @webnative
-   */
-  readonly required?: boolean;
-  /**
-   * The number of visible text lines for the control. If it is specified, it
-   * must be a positive integer. If it is not specified, the default value is
-   * `2`.
-   *
-   * @webnative
-   */
-  readonly rows?: number;
-  /**
-   * Defines whether the textarea may be checked for spelling errors.
-   *
-   * @webnative
-   */
-  readonly spellCheck?: boolean;
-  /**
-   * The value of the textarea.
-   *
-   * @webnative
-   */
-  value?: Value;
-  /**
-   * Indicates how the control should wrap the value for form submission.
-   * Possible values are:
-   *
-   * - `hard`: The browser automatically inserts line breaks (`CR+LF`) so that
-   * each line is no longer than the width of the control; the `cols` attribute
-   * must be specified for this to take effect
-   * - `soft`: The browser ensures that all line breaks in the entered value
-   * are a `CR+LF` pair, but no additional line breaks are added to the value.
-   * - `off`: Like `soft` but changes appearance to `white-space: pre` so line
-   * segments exceeding `cols` are not wrapped and the `<qds-textarea>` becomes
-   * horizontally scrollable.
-   *
-   * If this attribute is not specified, `soft` is its default value.
-   *
-   * @webnative
-   */
-  wrap?: Wrap;
-  /**
-   * Emitted when the textarea loses focus.
-   */
-  private readonly blurEmitter;
-  /**
-   * Emitted when an alteration to the textarea's value is committed by the
-   * user.
-   */
-  private readonly changeEmitter;
-  /**
-   * Emitted when the textarea gains focus.
-   */
-  private readonly focusEmitter;
-  /**
-   * Emitted when the textarea's value changes.
-   */
-  private readonly inputEmitter;
-  private readonly element;
-  private inheritedAttributes;
-  private textarea?;
-  private get computedDisabled();
-  /**
-   * Returns true if the element's value passes validity checks; otherwise,
-   * returns false, fires an invalid event at the element, and (if the event
-   * isn't canceled) reports the problem to the user.
-   */
-  reportValidity(): Promise<boolean>;
-  /**
-   * Selects the entire content of the `<qds-textarea>` element if the
-   * element's content is selectable.
-   */
-  select(): Promise<void>;
-  /**
-   * Sets a custom validity message for the textarea. If this message is not
-   * the empty string, then the element is considered invalid.
-   */
-  setCustomValidity(message: string): Promise<void>;
-  /**
-   * Sets the contents of the specified range of characters in the textarea
-   * element to a given string.
-   *
-   * @param replacement The string to insert.
-   * @param start The 0-based index of the first character to replace. Defaults to the current selectionStart value (the start of the user's current selection).
-   * @param end The 0-based index of the character _after_ the last character to replace. Defaults to the current selectionEnd value (the end of the user's current selection).
-   * @param selectionMode A string defining how the selection should be set after the text has been replaced. Possible values:
-   *
-   * - `"select"` selects the newly inserted text.
-   * - `"start"` moves the selection to just before the inserted text.
-   * - `"end"` moves the selection to just after the inserted text.
-   * - `"preserve"` attempts to preserve the selection.
-   */
-  setRangeText(replacement: string, start: number, end: number, selectionMode?: SelectionMode): Promise<void>;
-  /**
-   * Selects the specified range of characters within the textarea.
-   *
-   * @param start The offset into the input for the start of the selection.
-   * @param end The offset into the input for the end of the selection.
-   * @param direction The direction in which the selection is performed.
-   */
-  setSelectionRange(start: number | null, end: number | null, direction?: SelectDirection): Promise<void>;
-  protected disabledChanged(): void;
-  protected valueChanged(): void;
-  componentWillLoad(): void;
-  render(): any;
-  private readonly ref;
-  private readonly onBlur;
-  private readonly onChange;
-  private readonly onClick;
-  private readonly onFocus;
-  private readonly onInput;
-  private readonly onInvalid;
+    #private;
+    /**
+     * The textarea's size.
+     *
+     * > **_NOTE:_** The native [`size` HTML attribute][] is not supported. CSS
+     * `width` should be used instead if this functionality is needed.
+     *
+     * [`size` HTML attribute]: https://developer.mozilla.org/docs/Web/HTML/Attributes/size
+     */
+    readonly size?: Size;
+    /**
+     * The textarea's status.
+     */
+    readonly status?: TextAreaStatus;
+    /**
+     * Indicates whether the value of the textarea can be automatically completed
+     * by the browser. Possible values:
+     *
+     * `off`: The user must explicitly enter a value into this field for every
+     * use, or the document provides its own auto-completion method; the browser
+     * does not automatically complete the entry.
+     * `on`: The browser can automatically complete the value based on values
+     * that the user has entered during previous uses.
+     *
+     * If the `autocomplete` attribute is not specified on a `<qds-textarea>`
+     * element, then the browser uses the `autocomplete` attribute value of the
+     * `<qds-textarea>` element's form owner. The form owner is either the
+     * [`<form>`][] element that this `<qds-textarea>` element is a descendant of
+     * or the form element whose `id` is specified by the `form` attribute of the
+     * `qds-textarea` element. For more information, see the [`autocomplete`]
+     * attribute in [`<form>`][].
+     *
+     * [`<form>`]: https://developer.mozilla.org/docs/Web/HTML/Element/form
+     * [`autocomplete`]: https://developer.mozilla.org/docs/Web/HTML/Element/form#autocomplete
+     *
+     * @webnative
+     */
+    readonly autoComplete?: TextAreaAutoComplete;
+    /**
+     * The visible width of the text control, in average character widths. If it
+     * is specified, it must be a positive integer. If it is not specified, the
+     * default value is `20`.
+     *
+     * @webnative
+     */
+    readonly cols?: number;
+    /**
+     * Prevents the textarea from being interacted with: it cannot be pressed or
+     * focused.
+     *
+     * @webnative
+     */
+    disabled?: boolean;
+    /**
+     * Prevents the user from changing the value of the textarea.
+     */
+    readonly readonly?: boolean;
+    /**
+     * What action label (or icon) to present for the enter key on virtual
+     * keyboards. Possible values:
+     *
+     * - `"done"`: Typically meaning there is nothing more to input and the input
+     * method editor (IME) will be closed.
+     * - `"enter"`:	Typically inserting a new line.
+     * - `"go"`: 	Typically meaning to take the user to the target of the text
+     * they typed.
+     * - `"next"`: 	Typically taking the user to the next field that will accept
+     * text.
+     * - `"previous"`: Typically taking the user to the previous field that will
+     * accept text.
+     * - `"search"`: Typically taking the user to the results of searching for
+     * the text they have typed.
+     * - `"send"`: Typically delivering the text to its target.
+     *
+     * @webnative
+     */
+    readonly enterkeyhint?: EnterKeyHint;
+    /**
+     * The [`<form>`][] element to associate the input with (its form owner).
+     *
+     * The value of this attribute must be the id of a `<form>` in the same
+     * document. If this attribute is not set, the `<qds-textarea>` is associated
+     * with its ancestor `<form>` element, if any.
+     *
+     * This attribute lets you associate `<qds-textarea>` elements to `<form>`s
+     * anywhere in the document, not just inside a `<form>`. It can also override
+     * an ancestor `<form>` element.
+     *
+     * [`<form>`]: https://developer.mozilla.org/docs/Web/HTML/Element/form
+     *
+     * @readonly
+     * @webnative
+     */
+    readonly form: ElementInternals['form'] | string;
+    /**
+     * Provide a hint to browsers as to the type of virtual keyboard
+     * configuration to use when editing this element or its contents.
+     *
+     * @webnative
+     */
+    readonly inputmode?: InputMode;
+    /**
+     * Returns a list of the [`<label>`][] elements associated with the
+     * `qds-textarea` element.
+     *
+     * [`<label>`]: https://developer.mozilla.org/docs/Web/HTML/Element/label
+     *
+     * @readonly
+     * @webnative
+     */
+    readonly labels: ElementInternals['labels'];
+    /**
+     * The maximum number of characters (as UTF-16 code units) the user can enter
+     * into the textarea. This must be an non-negative integer value. If no
+     * `maxlength` is specified, or an invalid value is specified, the textarea
+     * has no maximum length.
+     *
+     * The textarea will fail [constraint validation][] if the length of the text
+     * entered into the field is greater than `maxlength` UTF-16 code units long.
+     * By default, browsers prevent users from entering more characters than
+     * allowed by the `maxlength` attribute. See [Client-side validation][] for
+     * more information.
+     *
+     * [constraint validation]: https://developer.mozilla.org/docs/Web/Guide/HTML/Constraint_validation
+     * [Client-side validation]: https://developer.mozilla.org/docs/Web/HTML/Element/input#client-side_validation
+     *
+     * @webnative
+     */
+    readonly maxLength?: number;
+    /**
+     * The minimum number of characters (as UTF-16 code units) the user can enter
+     * into the textarea. This must be an non-negative integer value smaller than
+     * or equal to the value specified by `maxlength`. If no `minlength` is
+     * specified, or an invalid value is specified, the textarea has no minimum
+     * length.
+     *
+     * The textarea will fail [constraint validation][] if the length of the text
+     * entered into the field is fewer than `minlength` UTF-16 code units long,
+     * preventing form submission. See [Client-side validation][] for more
+     * information.
+     *
+     * [constraint validation]: https://developer.mozilla.org/docs/Web/Guide/HTML/Constraint_validation
+     * [Client-side validation]: https://developer.mozilla.org/docs/Web/HTML/Element/input#client-side_validation
+     *
+     * @webnative
+     */
+    readonly minLength?: number;
+    /**
+     * The name of the textarea, which is submitted with the form data.
+     *
+     * @webnative
+     */
+    readonly name?: string;
+    /**
+     * Text that appears in the textarea when it has no value set.
+     *
+     * @webnative
+     */
+    readonly placeholder?: string;
+    /**
+     * A value must be specified for the textarea before the owning form can be
+     * submitted.
+     *
+     * See [Client-side validation][] and the [HTML attribute: `required`][] for
+     * more information.
+     *
+     * [Client-side validation]: https://developer.mozilla.org/docs/Web/HTML/Element/input#client-side_validation
+     * [HTML attribute: `required`]: https://developer.mozilla.org/docs/Web/HTML/Attributes/required
+     *
+     * @webnative
+     */
+    readonly required?: boolean;
+    /**
+     * The number of visible text lines for the control. If it is specified, it
+     * must be a positive integer. If it is not specified, the default value is
+     * `2`.
+     *
+     * @webnative
+     */
+    readonly rows?: number;
+    /**
+     * Get or set the selection direction of a text selection.
+     *
+     * > **_NOTE:_** This property has no effect when used as an attribute.
+     *
+     * @webnative
+     */
+    selectionDirection: HTMLInputElement['selectionDirection'];
+    /**
+     * Get or set the ending position or offset of a text selection.
+     *
+     * > **_NOTE:_** This property has no effect when used as an attribute.
+     *
+     * @webnative
+     */
+    selectionEnd: HTMLInputElement['selectionEnd'];
+    /**
+     * Get or set the starting position or offset of a text selection.
+     *
+     * > **_NOTE:_** This property has no effect when used as an attribute.
+     *
+     * @webnative
+     */
+    selectionStart: HTMLInputElement['selectionStart'];
+    /**
+     * The error message that would be shown to the user if the `<qds-select>`
+     * was to be checked for validity.
+     *
+     * @readonly
+     * @webnative
+     */
+    readonly validationMessage: ElementInternals['validationMessage'];
+    /**
+     * The [`ValidityState`][] object for this `<qds-select>`.
+     *
+     * [`ValidityState`]: https://developer.mozilla.org/docs/Web/API/ValidityState
+     *
+     * @readonly
+     * @webnative
+     */
+    readonly validity: ElementInternals['validity'];
+    /**
+     * The value of the textarea.
+     *
+     * @webnative
+     */
+    value?: Value;
+    /**
+     * True if `<qds-textarea>` will be validated when the form is submitted;
+     * false otherwise.
+     *
+     * @readonly
+     * @webnative
+     */
+    readonly willValidate: ElementInternals['willValidate'];
+    /**
+     * Indicates how the control should wrap the value for form submission.
+     * Possible values are:
+     *
+     * - `hard`: The browser automatically inserts line breaks (`CR+LF`) so that
+     * each line is no longer than the width of the control; the `cols` attribute
+     * must be specified for this to take effect
+     * - `soft`: The browser ensures that all line breaks in the entered value
+     * are a `CR+LF` pair, but no additional line breaks are added to the value.
+     * - `off`: Like `soft` but changes appearance to `white-space: pre` so line
+     * segments exceeding `cols` are not wrapped and the `<qds-textarea>` becomes
+     * horizontally scrollable.
+     *
+     * If this attribute is not specified, `soft` is its default value.
+     *
+     * @webnative
+     */
+    readonly wrap?: Wrap;
+    private readonly internals;
+    /**
+     * Emitted when the textarea loses focus.
+     */
+    private readonly blurEmitter;
+    /**
+     * Emitted when an alteration to the textarea's value is committed by the
+     * user.
+     */
+    private readonly changeEmitter;
+    /**
+     * Emitted when the textarea gains focus.
+     */
+    private readonly focusEmitter;
+    /**
+     * Emitted when the textarea's value changes.
+     */
+    private readonly inputEmitter;
+    private readonly host;
+    private tabIndex?;
+    protected onClick(event: MouseEvent): void;
+    protected disabledChanged(): void;
+    protected selectionDirectionChanged(): void;
+    protected selectionEndChanged(): void;
+    protected selectionStartChanged(): void;
+    protected tabindexChanged(newValue: string): void;
+    protected validationChanged(): void;
+    protected valueChanged(): void;
+    protected statusChanged(): void;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    render(): any;
+    checkValidity: ElementInternals['checkValidity'];
+    reportValidity: ElementInternals['reportValidity'];
+    setCustomValidity: HTMLTextAreaElement['setCustomValidity'];
+    select: HTMLTextAreaElement['select'];
+    setRangeText: (replacement: string, start: number, end: number, selectionMode?: SelectionMode) => void;
+    setSelectionRange: HTMLTextAreaElement['setSelectionRange'];
 }
 //# sourceMappingURL=textarea.d.ts.map