@govtechsg/sgds-web-component 0.0.13 → 0.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/README.md +571 -41
  2. package/base/card-element.d.ts +4 -4
  3. package/base/dropdown-element.d.ts +13 -16
  4. package/base/link-element.d.ts +2 -0
  5. package/components/Accordion/index.d.ts +2 -2
  6. package/components/ActionCard/index.d.ts +1 -1
  7. package/components/ActionCard/sgds-action-card.d.ts +38 -10
  8. package/components/Alert/index.d.ts +1 -1
  9. package/components/Badge/index.d.ts +1 -1
  10. package/components/Button/index.d.ts +1 -1
  11. package/components/Card/index.d.ts +1 -0
  12. package/components/Card/sgds-card.d.ts +24 -0
  13. package/components/Checkbox/index.d.ts +1 -1
  14. package/components/Checkbox/sgds-checkbox.d.ts +3 -3
  15. package/components/Dropdown/index.d.ts +2 -3
  16. package/components/Dropdown/sgds-dropdown-item.d.ts +6 -2
  17. package/components/Dropdown/sgds-dropdown.d.ts +19 -0
  18. package/components/FileUpload/index.d.ts +1 -1
  19. package/components/FileUpload/sgds-file-upload.d.ts +44 -0
  20. package/components/Footer/index.d.ts +1 -1
  21. package/components/Input/index.d.ts +1 -1
  22. package/components/Input/sgds-input.d.ts +2 -2
  23. package/components/Mainnav/index.d.ts +3 -3
  24. package/components/Mainnav/sgds-mainnav-dropdown.d.ts +4 -0
  25. package/components/Mainnav/sgds-mainnav.d.ts +1 -2
  26. package/components/Masthead/index.d.ts +1 -1
  27. package/components/Modal/index.d.ts +1 -1
  28. package/components/Modal/sgds-modal.d.ts +45 -0
  29. package/components/QuantityToggle/index.d.ts +1 -1
  30. package/components/QuantityToggle/sgds-quantity-toggle.d.ts +39 -14
  31. package/components/Radio/index.d.ts +2 -2
  32. package/components/Radio/sgds-radio-group.d.ts +3 -3
  33. package/components/Radio/sgds-radio.d.ts +4 -3
  34. package/components/Sidenav/index.d.ts +3 -3
  35. package/components/Sidenav/sgds-sidenav-item.d.ts +7 -7
  36. package/components/Sidenav/sgds-sidenav-link.d.ts +1 -1
  37. package/components/Sidenav/sgds-sidenav.d.ts +5 -2
  38. package/components/Spinner/index.d.ts +1 -1
  39. package/components/Stepper/sgds-stepper.d.ts +31 -7
  40. package/components/Tab/index.d.ts +3 -3
  41. package/components/Textarea/index.d.ts +1 -1
  42. package/components/Textarea/sgds-textarea.d.ts +2 -2
  43. package/components/Toast/index.d.ts +1 -1
  44. package/components/Tooltip/index.d.ts +1 -1
  45. package/index.d.ts +1 -0
  46. package/index.js +832 -570
  47. package/index.js.map +1 -1
  48. package/package.json +1 -1
  49. package/react/action-card/index.d.ts +3 -1
  50. package/react/{fileupload → card}/index.d.ts +1 -1
  51. package/react/cjs/index.js +936 -645
  52. package/react/cjs/index.js.map +1 -1
  53. package/react/dropdown/index.d.ts +2 -2
  54. package/react/file-upload/index.d.ts +5 -0
  55. package/react/index.d.ts +2 -1
  56. package/react/index.js +928 -638
  57. package/react/index.js.map +1 -1
  58. package/react/mainnav-dropdown/index.d.ts +2 -2
  59. package/react/modal/index.d.ts +7 -1
  60. package/react/quantity-toggle/index.d.ts +4 -1
  61. package/react/stepper/index.d.ts +8 -1
  62. package/umd/index.js +781 -590
  63. package/umd/index.js.map +1 -1
  64. package/components/FileUpload/sgds-fileupload.d.ts +0 -22
@@ -1,17 +1,41 @@
1
1
  import SgdsElement from "../../base/sgds-element";
2
+ /**
3
+ * @summary Steppers are used to inform users which step they are at in a form or a process
4
+ * @slot step-n - The slot for content in each step. "n" refers to numeral value starting from 1. e.g. step-1, step-2, step-3 etc.
5
+ *
6
+ * @event sgds-next-step - Emitted right before the next step is reached. Event is fired when nextStep method is called.
7
+ * @event sgds-previous-step - Emitted right before the previous step is reached. Event is fired when previousStep method is called.
8
+ * @event sgds-last-step - Emitted right before the last step is reached. Event is fired when lastStep method is called.
9
+ * @event sgds-first-step - Emitted on hide after animation has completed. Event is fired when firstStep method is called.
10
+ * @event sgds-arrived - Emitted right after the activeStep has updated its state, when upcoming step has arrived and its slot are rendered.
11
+ * @event sgds-reset - Emitted right before the step is reset to its defaultActiveStep. Event is fired when reset method is called.
12
+ *
13
+ */
2
14
  export declare class SgdsStepper extends SgdsElement {
3
15
  static styles: import("lit").CSSResultGroup[];
4
- steps: {
5
- title: number;
6
- stepHeader: string;
7
- }[];
16
+ /** The header name for steps in chronological order
17
+ */
18
+ steps: string[];
19
+ /** The current state of active step. Defaults to 0 */
8
20
  activeStep: number;
9
- connectedCallback(): void;
10
- incrementStep(): void;
11
- decrementStep(): void;
21
+ /**Gets or sets the default activeStep used to reset this element. The initial value corresponds to the one originally specified in the HTML that created this element. */
22
+ defaultActiveStep: number;
23
+ /** Moves the active step forward one step */
24
+ nextStep(): void;
25
+ /** Moves the active step back one step */
26
+ previousStep(): void;
27
+ /** Changes the active step to the last step */
12
28
  lastStep(): void;
29
+ /** Changes active step to the first step */
13
30
  firstStep(): void;
31
+ /** Resets the Stepper to its initial active step state */
32
+ reset(): void;
33
+ /**@internal */
14
34
  _onStepperItemClick(index: number): void;
35
+ /**@internal */
36
+ _handleActiveStepChange(): void;
37
+ /**@internal */
38
+ _handleKeyDown(event: KeyboardEvent, index: number): void;
15
39
  render(): import("lit").TemplateResult<1>;
16
40
  }
17
41
  export default SgdsStepper;
@@ -1,3 +1,3 @@
1
- export * from "./sgds-tab";
2
- export * from "./sgds-tabpanel";
3
- export * from "./sgds-tabgroup";
1
+ export { SgdsTab } from "./sgds-tab";
2
+ export { SgdsTabPanel } from "./sgds-tabpanel";
3
+ export { SgdsTabGroup } from "./sgds-tabgroup";
@@ -1 +1 @@
1
- export * from "./sgds-textarea";
1
+ export { SgdsTextarea } from "./sgds-textarea";
@@ -18,8 +18,6 @@ export declare class SgdsTextarea extends SgdsElement implements SgdsFormControl
18
18
  private resizeObserver;
19
19
  /**The textarea's label */
20
20
  label: string;
21
- /**The textarea's unique id */
22
- textareaId: string;
23
21
  /**The textarea's name attribute */
24
22
  name: string;
25
23
  /**Forwarded to the HTML native textarea element. Can be used to insert any bootstrap classes such as mt-2 */
@@ -60,6 +58,8 @@ export declare class SgdsTextarea extends SgdsElement implements SgdsFormControl
60
58
  invalid: boolean;
61
59
  /**@internal */
62
60
  valid: boolean;
61
+ /** @internal The textarea's unique id */
62
+ private textareaId;
63
63
  connectedCallback(): void;
64
64
  disconnectedCallback(): void;
65
65
  /** Sets focus on the textarea. */
@@ -1 +1 @@
1
- export { SgdsToast } from "./sgds-toast";
1
+ export { SgdsToast, ToastVariant } from "./sgds-toast";
@@ -1 +1 @@
1
- export * from "./sgds-tooltip";
1
+ export { SgdsTooltip } from "./sgds-tooltip";
package/index.d.ts CHANGED
@@ -22,3 +22,4 @@ export * from "./components/FileUpload";
22
22
  export * from "./components/Accordion";
23
23
  export * from "./components/Tooltip";
24
24
  export * from "./components/Spinner";
25
+ export * from "./components/Card";