Update API doc

melloware · Sep 2, 2024 · 708afc0 · 708afc0
1 parent 2244dbd
commit 708afc0
Showing 1 changed file with 75 additions and 4 deletions.
diff --git a/components/doc/common/apidoc/index.json b/components/doc/common/apidoc/index.json
@@ -47904,6 +47904,74 @@
         "interfaces": {
             "description": "Defines the custom interfaces used by the module.",
             "values": {
+                "StepPassThroughMethodOptions": {
+                    "description": "Custom passthrough(pt) option method.",
+                    "relatedProp": "",
+                    "props": [
+                        {
+                            "name": "parent",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "StepsThroughMethodOptions"
+                        },
+                        {
+                            "name": "context",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "StepContext"
+                        }
+                    ],
+                    "callbacks": []
+                },
+                "StepContext": {
+                    "description": "Defines current inline context in Steps component.",
+                    "relatedProp": "",
+                    "props": [
+                        {
+                            "name": "index",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "number",
+                            "description": "Step index."
+                        },
+                        {
+                            "name": "count",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "number",
+                            "description": "Total number of steps"
+                        },
+                        {
+                            "name": "first",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "boolean",
+                            "description": "Is this the first step?"
+                        },
+                        {
+                            "name": "last",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "boolean",
+                            "description": "Is this the last step?"
+                        },
+                        {
+                            "name": "selected",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "boolean",
+                            "description": "Is this step currently selected."
+                        },
+                        {
+                            "name": "disabled",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "boolean",
+                            "description": "Is this step currently disabled."
+                        }
+                    ],
+                    "callbacks": []
+                },
                 "StepsThroughMethodOptions": {
                     "description": "Custom passthrough(pt) option method.",
                     "relatedProp": "",
@@ -47946,28 +48014,28 @@
                             "name": "action",
                             "optional": true,
                             "readonly": false,
-                            "type": "StepsPassThroughType<HTMLAttributes<HTMLAnchorElement>>",
+                            "type": "StepPassThroughType<HTMLAttributes<HTMLAnchorElement>>",
                             "description": "Uses to pass attributes to the action's DOM element."
                         },
                         {
                             "name": "step",
                             "optional": true,
                             "readonly": false,
-                            "type": "StepsPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+                            "type": "StepPassThroughType<HTMLAttributes<HTMLSpanElement>>",
                             "description": "Uses to pass attributes to the step's DOM element."
                         },
                         {
                             "name": "label",
                             "optional": true,
                             "readonly": false,
-                            "type": "StepsPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+                            "type": "StepPassThroughType<HTMLAttributes<HTMLSpanElement>>",
                             "description": "Uses to pass attributes to the label's DOM element."
                         },
                         {
                             "name": "icon",
                             "optional": true,
                             "readonly": false,
-                            "type": "StepsPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
+                            "type": "StepPassThroughType<HTMLAttributes<HTMLSpanElement> | SVGProps<SVGSVGElement>>",
                             "description": "Uses to pass attributes to the icon's DOM element."
                         },
                         {
@@ -47987,6 +48055,9 @@
             "values": {
                 "StepsPassThroughType": {
                     "values": "PassThroughType<T, StepsThroughMethodOptions>"
+                },
+                "StepPassThroughType": {
+                    "values": "PassThroughType<T, StepPassThroughMethodOptions>"
                 }
             }
         }