@mcp-b/web-components 0.2.0

package/dist/text-area-B_mjCE9W.d.ts

@@ -0,0 +1,327 @@
+import { CSSResultGroup, PropertyValues } from "lit";
+import { SigveloFormControlElement } from "@mcp-b/wc-support/base/sigvelo-element";
+
+//#region src/components/text-area/text-area.d.ts
+/**
+ * <sigvelo-text-area>
+ *
+ * @summary Allows users to edit multi-line, plain text content.
+ * @tag sigvelo-text-area
+ * @documentation https://design-system.sigvelo.com/docs/components/text-area
+ * @status stable
+ * @since 1.0
+ *
+ * @slot label - The text area's label. For plain-text labels, you can use the `label` attribute instead.
+ * @slot description - The text area's description. For plain-text descriptions, you can use the `description`
+ *  attribute instead.
+ *
+ * @event sigvelo-blur - Emitted when the text area loses focus. This event does not bubble.
+ * @event sigvelo-change - Emitted when the user commits changes to the text area's value.
+ * @event sigvelo-focus - Emitted when the text area receives focus. This event does not bubble.
+ * @event sigvelo-input - Emitted when the text area receives input.
+ *
+ * @csspart label - The element that contains the text area's label.
+ * @csspart description - The element that contains the text area's description.
+ * @csspart visual-box - The element that wraps the internal text box.
+ * @csspart text-box - The internal text box, a `<textarea>` element.
+ *
+ * @cssstate disabled - Applied when the text area is disabled.
+ * @cssstate blank - Applied when the text area has a blank value.
+ * @cssstate focused - Applied when the text area has focus.
+ * @cssstate user-valid - Applied when the text area is valid and the user has sufficiently interacted with it.
+ * @cssstate user-invalid - Applied when the text area is invalid and the user has sufficiently interacted with it.
+ *
+ * @example Default
+ * ```html
+ * <sigvelo-text-area name="feedback" label="Feedback"></sigvelo-text-area>
+ * ```
+ *
+ * @example Labels and descriptions
+ * You can use the `label` and `description` attributes to provide plain text labels and descriptions for the text area. If you want to provide HTML, use the `label` and `description` slots instead.
+ *
+ * ```html
+ * <sigvelo-text-area name="feedback" label="Feedback">
+ *   <span slot="description">
+ *     For more information, <a href="https://example.com/" target="_blank">visit our website</a>.
+ *   </span>
+ * </sigvelo-text-area>
+ * ```
+ *
+ * @example Providing an initial value
+ * Use the `value` attribute to provide an initial value for the text area.
+ *
+ * ```html
+ * <sigvelo-text-area name="feedback" label="Feedback" value="This is the greatest and best song in the world."></sigvelo-text-area>
+ * ```
+ *
+ * @example Adding a placeholder
+ * Use the `placeholder` attribute to show a placeholder in the text area when it's empty.
+ *
+ * ```html
+ * <sigvelo-text-area
+ *   name="bio"
+ *   label="Biography"
+ *   placeholder="Tell us about yourself"
+ * ></sigvelo-text-area>
+ * ```
+ *
+ * @example Changing the number of rows
+ * Use the `rows` attribute to set the default number of text rows.
+ *
+ * ```html
+ * <sigvelo-text-area label="One row" rows="1"></sigvelo-text-area><br>
+ * <sigvelo-text-area label="Five rows" rows="5"></sigvelo-text-area>
+ * ```
+ *
+ * @example Resizing to fit content
+ * Text areas can grow with their content by setting the `resize` property to `auto`. The minimum number of rows shown is determine by the `rows` attribute.
+ *
+ * ```html
+ * <sigvelo-text-area label="Resizing to fit" resize="auto" rows="4"></sigvelo-text-area>
+ * ```
+ *
+ * @example Filled and unstyled text areas
+ * Set the `variant` attribute to `normal`, `filled`, or `unstyled` to change the text area's variant.
+ *
+ * ```html
+ * <sigvelo-text-area variant="normal" label="Normal text field" placeholder="Enter some text"></sigvelo-text-area><br>
+ * <sigvelo-text-area variant="filled" label="Filled" placeholder="Enter some text"></sigvelo-text-area><br>
+ * <sigvelo-text-area variant="unstyled" label="Unstyled" placeholder="Enter some text"></sigvelo-text-area>
+ * ```
+ *
+ * @example Changing the size
+ * Use the `size` attribute to change the text area's size.
+ *
+ * ```html
+ * <sigvelo-text-area size="xs" label="Extra small"></sigvelo-text-area><br>
+ * <sigvelo-text-area size="sm" label="Small"></sigvelo-text-area><br>
+ * <sigvelo-text-area size="md" label="Medium"></sigvelo-text-area><br>
+ * <sigvelo-text-area size="lg" label="Large"></sigvelo-text-area><br>
+ * <sigvelo-text-area size="xl" label="Extra large"></sigvelo-text-area>
+ * ```
+ *
+ * @example Disabling
+ * Use the `disabled` attribute to disable the text area.
+ *
+ * ```html
+ * <sigvelo-text-area label="Disabled" disabled></sigvelo-text-area>
+ * ```
+ *
+ * @example Showing labels on the side
+ * With the `sigvelo-side-label` utility, you can show labels on the side instead of on top of the text area. You can control the width of the label by setting the `--label-width` custom property.
+ *
+ * ```html
+ * <sigvelo-text-area
+ *   class="sigvelo-side-label"
+ *   style="--label-width: 8ch;"
+ *   name="name"
+ *   label="Feedback"
+ *   description="Let us know what you think"
+ * ></sigvelo-text-area>
+ * ```
+ *
+ * @example Validation
+ * A number of attributes can be used to enable validation using the Constraint Validation API. These include `required`, `minlength`, and `maxlength`. They work exactly like their native counterparts.
+ *
+ * ```html
+ * <form action="about:blank" method="get" target="_blank">
+ *   <sigvelo-text-area name="required" label="Required" required></sigvelo-text-area><br>
+ *   <sigvelo-text-area name="minlength" label="Minimum length (enter at least five characters)" required minlength="5"></sigvelo-text-area><br>
+ *   <sigvelo-text-area name="maxlength" label="Maximum length (enter no more than five characters)" required maxlength="5"></sigvelo-text-area><br>
+ *   <sigvelo-button type="submit" color="primary">Submit</sigvelo-button>
+ *   <sigvelo-button type="reset">Reset</sigvelo-button>
+ * </form>
+ * ```
+ *
+ * @example Using custom validation
+ * Use the `setCustomValidity()` method to make the text area invalid and show a custom error message on submit. This will override all other validation parameters. To clear the error, remove the attribute or set it to an empty string.
+ *
+ * ```html
+ * <form action="about:blank" method="get" target="_blank" id="text-area__custom-validation">
+ *   <sigvelo-text-area
+ *     name="feedback"
+ *     label="Feedback"
+ *     description="This field will be invalid until custom validation is removed"
+ *   ></sigvelo-text-area>
+ *   <br>
+ *   <sigvelo-button type="submit" color="primary">Submit</sigvelo-button>
+ * </form>
+ *
+ * <script type="module">
+ *   import { allDefined } from '/dist/sigvelo.js';
+ *
+ *   await allDefined();
+ *
+ *   const form = document.getElementById('text-area__custom-validation');
+ *   const textArea = form.querySelector('sigvelo-text-area');
+ *
+ *   textArea.setCustomValidity('Not so fast, bubba!');
+ * </script>
+ * ```
+ *
+ * @example Styling validation
+ * You can style valid and invalid text area using the `:valid` and `:invalid` pseudo classes.
+ *
+ * ```html
+ * <form action="about:blank" method="get" target="_blank" class="text-area__validation-pseudo">
+ *   <sigvelo-text-area
+ *     name="feedback"
+ *     label="Feedback"
+ *     description="This field is required"
+ *     required
+ *   ></sigvelo-text-area>
+ *   <br>
+ *   <sigvelo-button type="submit" color="primary">Submit</sigvelo-button>
+ *   <sigvelo-button type="reset">Reset</sigvelo-button>
+ * </form>
+ *
+ * <style>
+ *   .text-area__validation-pseudo {
+ *     sigvelo-text-area:valid {
+ *       outline: solid 2px var(--sigvelo-color-success-border);
+ *       outline-offset: .5rem;
+ *     }
+ *
+ *     sigvelo-text-area:invalid {
+ *       outline: solid 2px var(--sigvelo-color-danger-border);
+ *       outline-offset: .5rem;
+ *     }
+ *   }
+ * </style>
+ * ```
+ *
+ * However, these selectors will match even before the user has had a chance to fill out the form. More often than not, you'll want to use the `user-valid` and `user-invalid` custom states instead. This way, validation styles are only shown _after_ the user interacts with the form control or when the form is submitted.
+ *
+ * ```html
+ * <form action="about:blank" method="get" target="_blank" class="text-area__validation-custom">
+ *   <sigvelo-text-area
+ *     name="feedback"
+ *     label="Feedback"
+ *     description="This field is required"
+ *     required
+ *   ></sigvelo-text-area>
+ *   <br>
+ *   <sigvelo-button type="submit" color="primary">Submit</sigvelo-button>
+ *   <sigvelo-button type="reset">Reset</sigvelo-button>
+ * </form>
+ *
+ * <style>
+ *   .text-area__validation-custom {
+ *     sigvelo-text-area:state(user-valid) {
+ *       outline: solid 2px var(--sigvelo-color-success-border);
+ *       outline-offset: .5rem;
+ *     }
+ *
+ *     sigvelo-text-area:state(user-invalid) {
+ *       outline: solid 2px var(--sigvelo-color-danger-border);
+ *       outline-offset: .5rem;
+ *     }
+ *   }
+ * </style>
+ * ```
+ */
+declare class SigveloTextArea extends SigveloFormControlElement {
+  static formAssociated: boolean;
+  static observeSlots: boolean;
+  static styles: CSSResultGroup;
+  private resizeObserver;
+  private textAreaAutoSizer;
+  protected get focusableAnchor(): HTMLInputElement;
+  private textBox;
+  isInvalid: boolean;
+  hadUserInteraction: boolean;
+  wasSubmitted: boolean;
+  /**
+   * The text area's label. If you need to provide HTML in the label, use the `label` slot instead.
+   */
+  label: string;
+  /**
+   * The text area's description. If you need to provide HTML in the description, use the `description` slot instead.
+   */
+  description: string;
+  /** The name of the text area. This will be submitted with the form as a name/value pair. */
+  name: string;
+  /** The text area's value. */
+  value: string;
+  /** A placeholder to show in the text area when it's blank. */
+  placeholder: string;
+  /** Disables the text area. */
+  disabled: boolean;
+  /** Makes the text area a read-only area. */
+  readonly: boolean;
+  /** Determines how the text area can be resized. */
+  resize: "vertical" | "auto" | "none";
+  /** The default number of rows visible in the text area. */
+  rows: number;
+  /** The type of text area to render. */
+  variant: "normal" | "filled" | "unstyled";
+  /** The text area's size. */
+  size: "xs" | "sm" | "md" | "lg" | "xl";
+  /**
+   * The form to associate this control with. If omitted, the closest containing `<form>` will be used. The value of
+   * this attribute must be an ID of a form in the same document or shadow root.
+   */
+  form: string;
+  /**
+   * Makes the text area required. Form submission will not be allowed when this is set and the text area is blank.
+   */
+  required: boolean;
+  /** The minimum string length that will be considered valid. */
+  minLength: number;
+  /** The maximum string length that will be considered valid. */
+  maxLength: number;
+  /** Turns autocapitalize on or off in supported browsers. */
+  autocapitalize: "off" | "none" | "on" | "sentences" | "words" | "characters";
+  /**
+   * Tells the browser how to autocomplete the text area. See [this page](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
+   * for available values.
+   */
+  autocomplete: string;
+  /** Turns autocorrect on or off in supported browsers. Set to true or 'on' to enable, false or 'off' to disable. */
+  autocorrect: boolean;
+  /** Tells the browser to focus the text area when the page loads or a dialog is shown. */
+  autofocus: boolean;
+  /** Sets the enter key label on virtual keyboards. */
+  enterkeyhint: "enter" | "done" | "go" | "next" | "previous" | "search" | "send";
+  /**
+   * Provides the browser with a hint about the type of data that might be entered by the user, allowing the appropriate
+   * virtual keyboard to be displayed on supported devices.
+   */
+  inputmode: "none" | "text" | "decimal" | "numeric" | "tel" | "search" | "email" | "url";
+  /** Turns spell checking on or off in supported browsers. */
+  spellcheck: boolean;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  updated(changedProperties: PropertyValues<this>): void;
+  /** @internal Called when a containing fieldset is disabled. */
+  formDisabledCallback(isDisabled: boolean): void;
+  /** @internal Called when the form is reset. */
+  formResetCallback(): void;
+  private handleBlur;
+  private handleChange;
+  private handleFocus;
+  private handleHostInvalid;
+  private handleInput;
+  /** Updates the height of the text area based on its content and settings. */
+  private updateHeight;
+  /** Sets the form control's validity */
+  private updateValidity;
+  /** Sets focus to the text area. */
+  focus(): void;
+  /** Removes focus from the text area. */
+  blur(): void;
+  /** Selects all text in the text area. */
+  select(): void;
+  /** Sets the start and end positions of the current text selection in the text area. */
+  setSelectionRange(start: number, end: number, direction?: "forward" | "backward" | "none"): void;
+  /** Replaces a range of text in the text area with a new string. */
+  setRangeText(replacement: string, start?: number, end?: number, selectMode?: "select" | "start" | "end" | "preserve"): void;
+  render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+  interface HTMLElementTagNameMap {
+    "sigvelo-text-area": SigveloTextArea;
+  }
+}
+//#endregion
+export { SigveloTextArea as t };