@govtechsg/sgds-web-component 0.0.12 → 0.0.13

package/components/Table/sgds-table.d.ts

@@ -1,22 +1,73 @@
 import SgdsElement from "../../base/sgds-element";
+/**
+ * @summary The use of a table is to organise a collections of data into readable rows
+ *
+ * @cssproperty --sgds-table-bg - Table's background color
+ * @cssproperty --sgds-table-accent-bg - Table's accent background color
+ * @cssproperty --sgds-table-striped-color - Text color for striped table
+ * @cssproperty --sgds-table-striped-bg - Background color for striped table
+ * @cssproperty --sgds-table-active-color - Active text color for hovered row
+ * @cssproperty --sgds-table-active-bg - Active background color for hovered row
+ * @cssproperty --sgds-table-hover-color - Hovered text color for hover table
+ * @cssproperty --sgds-table-hover-bg - Hovered background color for hover table
+ */
 export declare class SgdsTable extends SgdsElement {
     static styles: import("lit").CSSResultGroup[];
+    /**
+     * Adds zebra-striping using striped to table row within the <tbody>
+     */
     striped: boolean;
+    /**
+     * Add borders to all sides of table and cells
+     */
     bordered: boolean;
+    /**
+     * Remove all borders to table and cells
+     */
     borderless: boolean;
+    /**
+     * Add hoverable state on table rows
+     */
     hover: boolean;
-    size?: string;
-    variant?: string;
+    /**
+     * Add <code>.table-sm</code> to make table more compact
+     */
+    size: string;
+    /**
+     * Use contextual classes to add colors to table
+     */
+    variant: string;
+    /**
+     * Sorting on a column is enabled by adding the sort property. The sorting algorithm is based on javascript array.sort() method. In ascending order from bottom, alphabets come first, followed by numbers, and then symbols. Similarly, in descending order from bottom, symbols come first, followed by numbers, and then alphabets.
+     */
     sort: boolean;
+    /**
+     * When removableSort is present, the third click removes the sorting from the column.
+     */
     removableSort: boolean;
-    responsive?: "sm" | "md" | "lg" | "xl";
+    /**
+     * Use responsive="sm", responsive="md" , responsive="lg", or responsive="xl" as needed to create responsive tables up to a particular breakpoint. From that breakpoint and up, the table will behave normally and not scroll horizontally. Use reponsive="always" to let table be always responsive
+     */
+    responsive: "sm" | "md" | "lg" | "xl" | "always";
+    /**
+     * Populate header cells using Arrays
+     */
     tableHeaders: any[];
+    /**
+     * Populate data cells using Arrays
+     */
     tableData: any[];
+    /** @internal */
     sortColumn: number | null;
+    /** @internal */
     sortAsc: boolean;
+    /** @internal */
     activeColumn: number | null;
+    /** @internal */
     sortClickCount: number;
+    /** @internal */
     clickCount: number;
+    /** @internal */
     originalTableData: Array<string[]>;
     connectedCallback(): void;
     handleHeaderClick(columnIndex: number): void;

package/components/Textarea/sgds-textarea.d.ts

@@ -1,48 +1,77 @@
 import SgdsElement from "../../base/sgds-element";
-export declare class SgdsTextArea extends SgdsElement {
+import { SgdsFormControl } from "../../utils/form";
+/**
+ * @summary Text areas allow for the collection of input longer than a single line.
+ *
+ * @event sgds-change - Emitted when an alteration to the control's value is committed by the user.
+ * @event sgds-input - Emitted when the control receives input and its value changes.
+ * @event sgds-focus - Emitted when textarea is in focus.
+ * @event sgds-blur - Emitted when textarea loses focus.
+ */
+export declare class SgdsTextarea extends SgdsElement implements SgdsFormControl {
     static styles: import("lit").CSSResultGroup[];
+    /**@internal */
     textarea: HTMLTextAreaElement;
-    private hasFocus;
+    /**@internal */
     private readonly formSubmitController;
+    /**@internal */
     private resizeObserver;
+    /**The textarea's label */
     label: string;
+    /**The textarea's unique id */
     textareaId: string;
-    name: any;
-    textareaClasses?: any;
+    /**The textarea's name attribute */
+    name: string;
+    /**Forwarded to the HTML native textarea element. Can be used to insert any bootstrap classes such as mt-2 */
+    textareaClasses?: string;
+    /**The textarea's value attribute. */
     value: string;
-    minlength: any;
-    maxlength: any;
+    /**Sets the minimum length of the textarea */
+    minlength: number;
+    /**Sets the maximum length of the textarea */
+    maxlength: number;
+    /**Enables spell checking on the textarea */
     spellcheck: boolean;
     /** The number of rows to display by default. */
     rows: number;
+    /**The textarea's placeholder text. */
     placeholder: string;
+    /**Feedback text for error state when validated */
     invalidFeedback: string;
+    /**Autofocus the textarea */
     autofocus: boolean;
+    /**Disables the textarea. */
     disabled: boolean;
+    /**Makes the textarea a required field. */
     required: boolean;
-    /** Makes the input readonly. */
+    /** Makes the textarea readonly. */
     readonly: boolean;
-    invalid: boolean;
-    valid: boolean;
     /** Controls how the textarea can be resized. */
     resize: "none" | "vertical" | "auto";
-    /** The textarea's inputmode attribute. */
+    /** The native textarea's inputmode attribute. It hints at the type of data that might be entered by the user while editing the element or its contents. This allows a browser to display an appropriate virtual keyboard. */
     inputmode: "none" | "text" | "decimal" | "numeric" | "tel" | "search" | "email" | "url";
+    /** The native textarea's autocorrect attribute. */
     autocorrect: string;
     /** Gets or sets the default value used to reset this element. The initial value corresponds to the one originally specified in the HTML that created this element. */
     defaultValue: string;
+    /** Allows invalidFeedback, invalid and valid styles to be visible with the input */
+    hasFeedback: boolean;
+    /**@internal */
+    invalid: boolean;
+    /**@internal */
+    valid: boolean;
     connectedCallback(): void;
     disconnectedCallback(): void;
     /** Sets focus on the textarea. */
     focus(options?: FocusOptions): void;
     /** Checks for validity and shows the browser's validation message if the control is invalid. */
     reportValidity(): boolean;
-    handleInvalid(): void;
+    /** Selects all the text in the textarea. */
+    select(): void;
+    handleInvalid(e: Event): void;
     handleChange(event: string): void;
     handleFocus(): void;
     handleBlur(): void;
-    /** Selects all the text in the textarea. */
-    select(): void;
     handleKeyDown(event: KeyboardEvent): void;
     handleRowsChange(): void;
     setTextareaHeight(): void;
@@ -50,4 +79,4 @@ export declare class SgdsTextArea extends SgdsElement {
     handleValueChange(): void;
     render(): import("lit").TemplateResult;
 }
-export default SgdsTextArea;
+export default SgdsTextarea;

package/index.d.ts

@@ -21,3 +21,4 @@ export * from "./components/Toast";
 export * from "./components/FileUpload";
 export * from "./components/Accordion";
 export * from "./components/Tooltip";
+export * from "./components/Spinner";