@govtechsg/sgds-web-component 0.0.12 → 1.0.0-rc.0

package/components/QuantityToggle/sgds-quantity-toggle.d.ts

@@ -1,28 +1,53 @@
-import { SgdsButton } from "../Button";
+import { ButtonVariant } from "../Button";
 import SgdsElement from "../../base/sgds-element";
-export declare class SgdsQuantityToggle extends SgdsElement {
-    input: HTMLInputElement;
-    leftBtn: SgdsButton;
-    lastBtn: SgdsButton;
+import { SgdsFormControl } from "../../utils/form";
+/**
+ * @summary The quantity toggle component is used to increase or decrease an incremental venue,  best used when the user needs to enter or adjust the quantity of a selected item.
+ *
+ * @csspart base - The base wrapper of the quantity toggle component.
+ * @csspart button - The plus and minus button of quantity toggle
+ *
+ * @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.
+ *
+ */
+export declare class SgdsQuantityToggle extends SgdsElement implements SgdsFormControl {
+    /**@internal */
+    private input;
+    /**@internal */
+    private plusBtn;
+    /**@internal */
+    private minusBtn;
     static styles: import("lit").CSSResultGroup[];
-    quantToggleId: string;
+    /**@internal */
+    private readonly formSubmitController;
+    /** The name of the input */
     name: string;
     /** The input's minimum value. */
-    min: number | string;
+    min: number;
     /** The input's maximum value. */
-    max: number | string;
-    size: "sm" | "lg" | "default";
-    count: number;
+    max: number;
+    /**Controls the size of the quantity toggle */
+    size: "sm" | "lg";
+    /**The input's value. Set to 0 by default */
+    value: number;
+    /** Disables the entire quantity toggle  */
     disabled: boolean;
-    quantityToggleClasses?: string;
+    /** The quantity toggle's button variants */
+    buttonVariant: ButtonVariant;
     /**
-     * Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is
-     * implied, allowing any numeric value.
+     * Controls the incremental / decremental value of the input
      */
     step: number;
     /** 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;
+    defaultValue: number;
+    /** @internal The id forwarded to input element */
+    private inputId;
     handleChange(event: string): void;
+    /** Simulates a click on the plus button */
+    plus(): void;
+    /** Simulates a click on the minus button */
+    minus(): void;
     onPlus(event: MouseEvent): void;
     onMinus(event: MouseEvent): void;
     render(): import("lit").TemplateResult;

package/components/Radio/sgds-radio-group.d.ts

@@ -1,41 +1,56 @@
 import SgdsElement from "../../base/sgds-element";
 import { FormSubmitController } from "../../utils/form";
+/**
+ * @summary RadioGroup group multiple radios so they function as a single form control.
+ *
+ * @slot default - The default slot where sgds-radio are placed.
+ *
+ * @event sgds-change - Emitted when the radio group's selected value changes.
+ */
 export declare class SgdsRadioGroup extends SgdsElement {
     static styles: import("lit").CSSResultGroup[];
+    /**@internal */
     protected readonly formSubmitController: FormSubmitController;
+    /**@internal */
     defaultSlot: HTMLSlotElement;
+    /**@internal */
     input: HTMLInputElement;
-    private defaultValue;
+    /**@internal */
+    defaultValue: string;
+    /**@internal */
     private customErrorMessage;
-    /**
-     * The radio group label. Required for proper accessibility. If you need to display HTML, you can use the `label` slot
-     * instead.
-     */
-    label: string;
+    /** @internal This will be true when the control is in an invalid state. */
+    invalid: boolean;
     /** The selected value of the control. */
     value: string;
     /** The name assigned to the radio controls. */
     name: string;
     /** Ensures a child radio is checked before allowing the containing form to submit. */
     required: boolean;
-    /**
-     * This will be true when the control is in an invalid state.
-     */
-    invalid: boolean;
+    /**Feedback text for error state when validated */
     invalidFeedback: string;
+    /** Allows invalidFeedback, invalid and valid styles to be visible with the input */
+    hasFeedback: boolean;
     handleValueChange(): void;
     connectedCallback(): void;
+    /** Gets and return the ValidityState object.  */
     get validity(): ValidityState;
     /** Checks for validity and shows the browser's validation message if the control is invalid. */
     reportValidity(): boolean;
-    private getAllRadios;
+    /**@internal */
+    private _radios;
     handleRadioClick(event: MouseEvent): void;
     handleKeyDown(event: KeyboardEvent): void;
     handleLabelClick(): void;
     handleSlotChange(): void;
-    handleInvalid(): void;
+    handleInvalid(e: Event): void;
     showNativeErrorMessage(): void;
     updateCheckedRadio(): void;
     render(): import("lit").TemplateResult<1>;
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        "sgds-radio-group": SgdsRadioGroup;
+    }
+}
 export default SgdsRadioGroup;

package/components/Radio/sgds-radio.d.ts

@@ -1,18 +1,27 @@
 import SgdsElement from "../../base/sgds-element";
+/**
+ * @summary Radio allows the user to select one option from a set while seeing all available options.
+ *
+ * @slot default - The label of the radio button
+ *
+ * @event sgds-focus - Emitted when the control gains focus.
+ * @event sgds-blur - Emitted when the control loses focus.
+ */
 export declare class SgdsRadio extends SgdsElement {
     static styles: import("lit").CSSResultGroup[];
+    /**
+     * Draws the radio in a checked state
+     */
     checked: boolean;
-    protected hasFocus: boolean;
     /** The radio's value attribute. */
     value: string;
-    /** For id/for pair of the HTML form control. */
-    radioId: string;
     /** Disables the radio. */
     disabled: boolean;
     /** Aligns the radios horizontally */
     isInline: boolean;
     /** For aria-label */
     ariaLabel: string;
+    private radioId;
     connectedCallback(): void;
     handleCheckedChange(): void;
     handleDisabledChange(): void;

package/components/Sidenav/sgds-sidenav-item.d.ts

@@ -5,29 +5,50 @@ import SgdsElement from "../../base/sgds-element";
  *
  * @slot - default slot for SgdsSidenavLink element.
  * @slot title - title slot for the content of SgdsSidenavItem's button / anchor element.
+ * @slot icon - icon slot for the content of SgdsSidenavItem's button / anchor element.
+ *
+ * @cssproperty --sidenav-item-button-border-left-width - sidenav item left border width
+ * @cssproperty --sidenav-item-padding-x - sidenav item padding left and right
+ * @cssproperty --sidenav-item-padding-y - sidenav item padding top and bottom
+ * @cssproperty --sidenav-item-icon-title-gap - the flex gap between sidenav item icon and title
  */
 export declare class SgdsSidenavItem extends SgdsElement {
     static styles: import("lit").CSSResultGroup[];
+    /** @internal */
     private myCollapse;
+    /** @internal */
     private bsCollapse;
-    /**  when true, toggles the sidenav-item to open on first load and
-     * set the active stylings.
+    /**
+     *  when true, toggles the sidenav-item to open on first load and set the active stylings.
      */
     active: boolean;
+    /**
+     *  When defined, converts SgdsSidenavItem from a button element to an Anchor element. In this case, only one level of navigation is allowed
+     */
     href: string;
-    collapseId: string;
-    buttonId: string;
+    /**
+     * Disables the SgdsSidenavItem
+     */
     disabled: boolean;
+    /**
+     * @internal Forwards to id attribute of div.collapse and aria-controls attribute of button in SgdsSidenavItem. By default, SgdsSidenavItem auto-generates a unique id. Override the default id by specifiying your own
+     */
+    private collapseId;
+    /**
+     * @internal Forwards to id attribute of button and aria-labelledby attribute of ul.sidenav-list in SgdsSidenavItem. By default, SgdsSidenavItem auto-generates a unique id. Override the default id by specifiying your own
+     */
+    private buttonId;
+    /** @internal */
     private index;
     private _onClick;
     private _onClickButton;
     private _onClickLink;
     /**
-     * closeItem - closes sidenav and inactivates it
+     * When invoked, closes the SgdsSidenavItem
      */
     closeItem(): void;
     /**
-     * openItem
+     * When invoked, opens the SgdsSidenavItem
      */
     openItem(): void;
     firstUpdated(): void;

package/components/Sidenav/sgds-sidenav-link.d.ts

@@ -1,6 +1,11 @@
 import LinkElement from "../../base/link-element";
 /**
- * @slot - default slot for label of anchor tag.
+ * @slot default - slot for label of anchor tag.
+ *
+ * @cssproperty --sidenav-link-font-size - sidenav link font size, default to `--sgds-body-font-size`
+ * @cssproperty --sidenav-link-padding-x - sidenav link padding left and right
+ * @cssproperty --sidenav-link-padding-y - sidenav link padding top and bottom
+ * @cssproperty --sidenav-link-disabled-color - sidenav link disabled color, default to `--sgds-gray-600`
  */
 export declare class SgdsSidenavLink extends LinkElement {
     static styles: import("lit").CSSResultGroup;

package/components/Sidenav/sgds-sidenav.d.ts

@@ -1,9 +1,16 @@
 import SgdsElement from "../../base/sgds-element";
 /**
- * @slot - default slot for SgdsSidenavItem element.
+ * @summary The side navigation is used to display a list of links to move between pages within a related category.
+ * It is used as a secondary form of navigation where the primary navigation is located hierachically above the page frame.
+ * Maximum two levels of navigations are allowed.
+ *
+ * @slot default - Default slot for SgdsSidenavItem element.
+ *
+ * @cssproperty --sidenav-theme-color - overall sidenav theme color
  */
 export declare class SgdsSidenav extends SgdsElement {
     static styles: import("lit").CSSResultGroup;
+    /** Allow sidenav items to stay open when another item is opened */
     alwaysOpen: boolean;
     render(): import("lit").TemplateResult<1>;
 }

package/components/Spinner/index.d.ts

@@ -0,0 +1 @@
+export { SgdsSpinner } from "./sgds-spinner";

package/components/Spinner/sgds-spinner.d.ts

@@ -0,0 +1,11 @@
+import SgdsElement from "../../base/sgds-element";
+export type Type = "border" | "grow";
+export type Color = "primary" | "secondary" | "success" | "danger" | "warning" | "info" | "light" | "dark";
+export declare class SgdsSpinner extends SgdsElement {
+    static styles: import("lit").CSSResultGroup[];
+    type: Type;
+    color: Color;
+    spinnerClasses?: string;
+    render(): import("lit").TemplateResult;
+}
+export default SgdsSpinner;

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;
-    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;
+    /** @internal The textarea's unique id */
+    private textareaId;
     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,5 @@ export * from "./components/Toast";
 export * from "./components/FileUpload";
 export * from "./components/Accordion";
 export * from "./components/Tooltip";
+export * from "./components/Spinner";
+export * from "./components/Card";