@skf-design-system/ui-components 0.0.1-beta.4 → 1.0.0-beta.3

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

@@ -12,7 +12,7 @@ interface SkfTextAreaProps extends Omit<FormFieldBaseProps, 'type'> {
 /**
  * The skf-textarea is used to create a textarea. Use it inside a form element or wherever you like.
  *
- * @documentation See [InVision DSM](https://skf.invisionapp.com/dsm/ab-skf/4-web-applications/nav/5fa7caf78c01200018354495/asset/619e4125b3d2147c0c584b11) for design principles.
+ * @documentation See [zeroheight](https://zeroheight.com/853e936c9/p/143f9d-text-area) for design principles.
  *
  * @attribute {boolean} disabled - If true, sets disabled state
  * @attribute {boolean} required - If true, value is required or must be checked for the form to be submittable
@@ -20,48 +20,51 @@ interface SkfTextAreaProps extends Omit<FormFieldBaseProps, 'type'> {
  * @event change - Fires when the value of the input changes
  * @event invalid - Fires when the input is invalid
  *
- * @slot The textareas label. Alternatively, you can use the `label` attribute.
+ * @slot - The textareas label. Alternatively, you can use the `label` attribute.
  *
  * @tagname skf-textarea
  */
 export declare class SkfTextArea extends FormBase implements SkfTextAreaProps {
     static styles: CSSResultGroup;
     private customError;
-    /** If provided, sets the cols of the textarea */
-    cols?: number | undefined;
-    /** If provided, forces component to invalid state until removed. Its value is used as hint text. */
+    /** If defined, sets the cols of the textarea */
+    cols?: number;
+    /** If defined, forces component to invalid state until removed. Its value is used as hint text. */
     set customInvalid(value: string | undefined);
     get customInvalid(): string | undefined;
-    /** If provided, outputs helping hints in console */
-    debug: boolean;
-    /** hide-label - If true, hides the label visually */
-    hideLabel: boolean;
-    /** If provided, displays informational text below the field */
+    /** If true, outputs helping hints in console */
+    debug?: boolean;
+    /** If true, hides the label visually */
+    hideLabel?: boolean;
+    /** If defined, displays informational text below the field */
     hint?: string;
-    /** The input's label. Alternatively, you can use the component slot. */
-    label: string;
-    /** If provided, adds name to the input-element */
+    /** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
+    label?: string;
+    /** If defined, adds name to the input-element */
     name?: string;
-    /** If provided, sets the maximum character length to accept for this input */
+    /** If defined, sets the maximum character length to accept for this input */
     maxLength?: number;
-    /** If provided, sets the minimum character length to accept for this input */
+    /** If defined, sets the minimum character length to accept for this input */
     minLength?: number;
-    /** If provided, displays placeholder text */
+    /** If defined, displays placeholder text */
     placeholder?: string;
     /** If true, makes the element not mutable, meaning the user can not edit the control */
     readonly?: boolean;
-    /** If provided, renders an alternative A11y text for the asterisk */
+    /** If defined, renders an alternative A11y text for the asterisk */
     requiredLabel?: string;
-    /** If provided, sets the rows of the textarea */
-    rows?: number | undefined;
-    /** @type { "success" | "error" } - If provided, displays provided severity state */
+    /** If defined, sets the rows of the textarea */
+    rows?: number;
+    /**
+     * If defined, displays provided severity state
+     * @type {"success" | "info" | "warning" | "alert"}
+     */
     severity?: SkfTextAreaProps['severity'];
     /** If true, displays valid state after interaction */
     showValid?: boolean;
-    /** If provided, displays an alternative size */
+    /** Size of the Textarea */
     size?: 'sm' | 'md';
-    /** If provided, sets validation start, "input", "change" or "submit" */
-    validateOn?: 'input' | 'change' | 'submit';
+    /** Sets validation start */
+    validateOn: 'input' | 'change' | 'submit';
     /** The current value of the text area  */
     value: string;
     /** @internal */

package/dist/components/textarea/textarea.component.js

@@ -14,7 +14,7 @@ var $ = Object.defineProperty, E = Object.getOwnPropertyDescriptor, e = (h, t, s
 };
 const u = class u extends m {
   constructor() {
-    super(...arguments), this.cols = 20, this.debug = !1, this.hideLabel = !1, this.label = "Default label", this.rows = 2, this.size = "md", this.validateOn = "change", this.value = "", this.invalid = !1, this._resetValue = (t) => {
+    super(...arguments), this.size = "md", this.validateOn = "change", this.value = "", this.invalid = !1, this._resetValue = (t) => {
       var s;
       t.stopPropagation(), this.value = ((s = this.getAttribute("value")) == null ? void 0 : s.trim()) ?? "", this._internals.setFormValue(this.value), this.$input.focus();
     }, this._handleInput = () => {
@@ -22,7 +22,7 @@ const u = class u extends m {
     };
   }
   set customInvalid(t) {
-    this.customError = String(t);
+    this.customError = t || "";
   }
   get customInvalid() {
     return this.customError;
@@ -78,14 +78,15 @@ const u = class u extends m {
   render() {
     var t, s;
     return p`
-			<div id="field">
+			<div id="root">
 				<label>
 					<div class=${this.hideLabel ? "visually-hidden" : ""} id="label">
-						${this.label} ${this.required ? c(this.requiredLabel) : null}
+						<slot>${this.label}</slot> ${this.required ? c(this.requiredLabel) : null}
 					</div>
 					<div id="input">
 						<textarea
 							?disabled=${this.disabled}
+							?readonly=${this.readonly}
 							?required=${this.required}
 							.value=${this.value}
 							@input=${this._handleInput}
@@ -93,22 +94,24 @@ const u = class u extends m {
 							aria-errormessage=${n((s = this.hint) != null && s.trim() ? "hint" : v)}
 							aria-invalid=${!!this.invalid}
 							cols=${n(this.cols)}
-							name=${n(this.name)}
 							maxlength=${n(this.maxLength)}
 							minlength=${n(this.minLength)}
+							name=${n(this.name)}
 							placeholder=${n(this.placeholder)}
-							?readonly=${this.readonly}
 							rows=${n(this.rows)}
 						>
 						</textarea>
 					</div>
 				</label>
-				${this.hint && p`<skf-hint
-					aria-live=${this.invalid ? "assertive" : "polite"}
-					id="hint"
-					severity=${n(_(this.severity, this.invalid))}
-					>${this.hint}</skf-hint
-				>`}
+				${this.hint && p`
+					<skf-hint
+						aria-live=${this.invalid ? "assertive" : "polite"}
+						id="hint"
+						severity=${n(_(this.severity, this.invalid))}
+					>
+						${this.customInvalid ? this.customInvalid : this.hint}
+					</skf-hint>
+				`}
 			</div>
 		`;
   }