@govtechsg/sgds-web-component 3.18.0 → 3.18.1-rc.1

package/css/fouc.css

@@ -51,6 +51,7 @@ sgds-sidenav-link:not(:defined),
 sgds-sidenav:not(:defined),
 sgds-skeleton:not(:defined),
 sgds-spinner:not(:defined),
+sgds-step:not(:defined),
 sgds-stepper:not(:defined),
 sgds-subnav-item:not(:defined),
 sgds-subnav:not(:defined),

package/custom-elements.json

@@ -18731,6 +18731,166 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/Stepper/sgds-step.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "SgdsStep",
+          "slots": [
+            {
+              "description": "Additional content to display under the step header",
+              "name": "default"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "stepHeader",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "The header text for the step",
+              "attribute": "stepHeader",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "iconName",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Optional icon name to display instead of step number",
+              "attribute": "iconName",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "component",
+              "type": {
+                "text": "unknown"
+              },
+              "description": "Optional component to render for this step",
+              "attribute": "component"
+            },
+            {
+              "kind": "method",
+              "name": "emit",
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "options",
+                  "optional": true,
+                  "type": {
+                    "text": "CustomEventInit<T>"
+                  }
+                }
+              ],
+              "description": "Emits a custom event with more convenient defaults.",
+              "type": {},
+              "inheritedFrom": {
+                "name": "SgdsElement",
+                "module": "src/base/sgds-element.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "define",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "elementConstructor",
+                  "default": "this"
+                },
+                {
+                  "name": "options",
+                  "default": "{}",
+                  "type": {
+                    "text": "ElementDefinitionOptions"
+                  }
+                }
+              ],
+              "type": {},
+              "inheritedFrom": {
+                "name": "SgdsElement",
+                "module": "src/base/sgds-element.ts"
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "stepHeader",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "The header text for the step",
+              "fieldName": "stepHeader"
+            },
+            {
+              "name": "iconName",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Optional icon name to display instead of step number",
+              "fieldName": "iconName"
+            },
+            {
+              "name": "component",
+              "type": {
+                "text": "unknown"
+              },
+              "description": "Optional component to render for this step",
+              "fieldName": "component"
+            }
+          ],
+          "superclass": {
+            "name": "SgdsElement",
+            "module": "/src/base/sgds-element"
+          },
+          "summary": "A step within a stepper component",
+          "tagName": "sgds-step",
+          "customElement": true,
+          "modulePath": "src/components/Stepper/sgds-step.ts",
+          "cssProperties": [],
+          "cssParts": [],
+          "cssStates": [],
+          "events": []
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SgdsStep",
+          "declaration": {
+            "name": "SgdsStep",
+            "module": "src/components/Stepper/sgds-step.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "SgdsStep",
+            "module": "src/components/Stepper/sgds-step.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/Stepper/sgds-stepper.ts",
@@ -18739,6 +18899,12 @@
           "kind": "class",
           "description": "",
           "name": "SgdsStepper",
+          "slots": [
+            {
+              "description": "slot for sgds-step children",
+              "name": "default"
+            }
+          ],
           "members": [
             {
               "kind": "field",
@@ -18747,7 +18913,8 @@
                 "text": "IStepMetaData[]"
               },
               "default": "[]",
-              "description": "The metadata of stepper, type `IStepMetaData`, that consist of `stepHeader: string`, `component:unknown`, `iconName:string`. `stepHeader` is the name of the step and `component` is the content that should appear at the each step. `component` is set to `unknown` to allow users to pass in their desired component based on the framework of choice. e.g. pass in your own react/angular/vue component or it can also be a text content.\nIt is required to populate this array to properly render the stepper. By default, stepper markers will render numbers. For icon stepper markers, pass the name of sgds icon via `iconName` key. `iconName` is optional.",
+              "description": "The metadata of stepper, type `IStepMetaData`. Deprecated: use sgds-step child components instead.",
+              "deprecated": "Use sgds-step child components instead of the steps property",
               "attribute": "steps"
             },
             {
@@ -18783,6 +18950,26 @@
               "attribute": "clickable",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "linear",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When true, the stepper's steps can only be clicked in a linear manner",
+              "attribute": "linear",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "_totalSteps",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "0"
+            },
             {
               "kind": "method",
               "name": "getComponent",
@@ -18928,7 +19115,8 @@
                 "text": "IStepMetaData[]"
               },
               "default": "[]",
-              "description": "The metadata of stepper, type `IStepMetaData`, that consist of `stepHeader: string`, `component:unknown`, `iconName:string`. `stepHeader` is the name of the step and `component` is the content that should appear at the each step. `component` is set to `unknown` to allow users to pass in their desired component based on the framework of choice. e.g. pass in your own react/angular/vue component or it can also be a text content.\nIt is required to populate this array to properly render the stepper. By default, stepper markers will render numbers. For icon stepper markers, pass the name of sgds icon via `iconName` key. `iconName` is optional.",
+              "description": "The metadata of stepper, type `IStepMetaData`. Deprecated: use sgds-step child components instead.",
+              "deprecated": "Use sgds-step child components instead of the steps property",
               "fieldName": "steps"
             },
             {
@@ -18957,6 +19145,15 @@
               "default": "false",
               "description": "When true, the stepper's steps will be clickable",
               "fieldName": "clickable"
+            },
+            {
+              "name": "linear",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When true, the stepper's steps can only be clicked in a linear manner",
+              "fieldName": "linear"
             }
           ],
           "superclass": {
@@ -18969,8 +19166,7 @@
           "modulePath": "src/components/Stepper/sgds-stepper.ts",
           "cssProperties": [],
           "cssParts": [],
-          "cssStates": [],
-          "slots": []
+          "cssStates": []
         }
       ],
       "exports": [
@@ -26444,7 +26640,7 @@
   "package": {
     "name": "@govtechsg/sgds-web-component",
     "description": "",
-    "version": "3.18.0",
+    "version": "3.18.1-rc.1",
     "author": "GovTechSG",
     "license": "MIT"
   }