docs(VStepperVertical): resolve missing api descriptions

vuetifyjs · May 10, 2024 · 2276b1e · 2276b1e
1 parent e440e6a
commit 2276b1e
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 31 deletions.
diff --git a/packages/api-generator/src/locale/en/Stepper.json b/packages/api-generator/src/locale/en/Stepper.json
@@ -0,0 +1,27 @@
+{
+  "props": {
+    "altLabels": "Places the labels beneath the step.",
+    "editable": "Marks step as editable.",
+    "hideActions": "Hide actions bar (prev and next buttons).",
+    "itemTitle": "Property on supplied `items` that contains its title.",
+    "itemValue": "Property on supplied `items` that contains its value.",
+    "mobile": "Forces the stepper into a mobile state, removing labels from stepper items.",
+    "nextText": "The text used for the Next button.",
+    "prevText": "The text used for the Prev button.",
+    "nonLinear": "Allow user to jump to any step."
+  },
+  "slots": {
+    "[`header-item.${string}`]": "Slot for customizing header items when using the [items](/api/v-stepper/#props-items) prop.",
+    "[`item.${string}`]": "Slot for customizing the content for each step.",
+    "actions": "Slot for customizing [v-stepper-actions](/api/v-stepper-actions/).",
+    "header": "Slot for customizing the header.",
+    "header-item": "Slot for customizing all header items.",
+    "icon": "Slot for customizing all stepper item icons.",
+    "next": "Slot for customizing the next step functionailty",
+    "prev": "Slot for customizing the prev step functionality"
+  },
+  "exposed": {
+    "next": "Move to the next step.",
+    "prev": "Move to the prev step."
+  }
+}
diff --git a/packages/api-generator/src/locale/en/StepperItem.json b/packages/api-generator/src/locale/en/StepperItem.json
@@ -0,0 +1,12 @@
+{
+  "props": {
+    "complete": "Marks step as complete.",
+    "completeIcon": "Icon to display when step is marked as completed.",
+    "editable": "Marks step as editable.",
+    "editIcon": "Icon to display when step is editable.",
+    "errorIcon": "Icon to display when step has an error.",
+    "error": "Puts the stepper item in a manual error state.",
+    "rules": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`.",
+    "step": "Content to display inside step circle."
+  }
+}
diff --git a/packages/api-generator/src/locale/en/VExpansionPanelTitle.json b/packages/api-generator/src/locale/en/VExpansionPanelTitle.json
@@ -2,6 +2,7 @@
   "props": {
     "collapseIcon": "Icon used when the expansion panel is in a collapsable state.",
     "expandIcon": "Icon used when the expansion panel is in a expandable state.",
-    "hideActions": "Hide the expand icon in the content title."
+    "hideActions": "Hide the expand icon in the content title.",
+    "static": "Remove title size expansion when selected."
   }
 }
diff --git a/packages/api-generator/src/locale/en/VStepper.json b/packages/api-generator/src/locale/en/VStepper.json
@@ -1,26 +1,6 @@
 {
   "props": {
-    "altLabels": "Places the labels beneath the step.",
-    "editable": "Marks step as editable.",
-    "flat": "Removes the stepper's elevation.",
-    "hideActions": "Hide actions bar (prev and next buttons).",
-    "itemTitle": "Property on supplied `items` that contains its title.",
-    "itemValue": "Property on supplied `items` that contains its value.",
-    "mobile": "Forces the stepper into a mobile state, removing labels from stepper items.",
-    "nextText": "The text used for the Next button.",
-    "prevText": "The text used for the Prev button.",
-    "nonLinear": "Allow user to jump to any step.",
-    "vertical": "Display steps vertically."
-  },
-  "slots": {
-    "[`header-item.${string}`]": "Slot for customizing header items when using the [items](/api/v-stepper/#props-items) prop.",
-    "[`item.${string}`]": "Slot for customizing the content for each step.",
-    "actions": "Slot for customizing [v-stepper-actions](/api/v-stepper-actions/).",
-    "header": "Slot for customizing the header.",
-    "header-item": "Slot for customizing all header items.",
-    "icon": "Slot for customizing all stepper item icons.",
-    "next": "Slot for customizing the next step functionailty",
-    "prev": "Slot for customizing the prev step functionality"
+    "flat": "Removes the stepper's elevation."
   },
   "exposed": {
     "next": "Move to the next step.",

diff --git a/packages/api-generator/src/locale/en/VStepperItem.json b/packages/api-generator/src/locale/en/VStepperItem.json
@@ -1,16 +1,7 @@
 {
   "props": {
-    "complete": "Marks step as complete.",
-    "completeIcon": "Icon to display when step is marked as completed.",
-    "editable": "Marks step as editable.",
-    "editIcon": "Icon to display when step is editable.",
-    "errorIcon": "Icon to display when step has an error.",
-    "error": "Puts the stepper item in a manual error state.",
-    "rules": "Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`.",
-    "step": "Content to display inside step circle."
   },
   "events": {
-    "click": "Emitted when component is clicked."
   },
   "slots": {
     "icon": "Slot for customizing all stepper item icons."

diff --git a/packages/api-generator/src/locale/en/VStepperVerticalActions.json b/packages/api-generator/src/locale/en/VStepperVerticalActions.json
@@ -0,0 +1,9 @@
+{
+  "props": {
+    "finish": "Changes the Next button to use the finish text.",
+    "finishText": "The text used for the finish button. Shown when using the **finish** prop."
+  },
+  "events": {
+    "click:finish": "Emitted when the clicking the finish button."
+  }
+}
diff --git a/packages/api-generator/src/locale/en/VStepperVerticalItem.json b/packages/api-generator/src/locale/en/VStepperVerticalItem.json
@@ -0,0 +1,7 @@
+{
+  "events": {
+    "click:finish": "Event emitted when clicking the finish button",
+    "click:next": "Event emitted when clicking the next button",
+    "click:previous": "Event emitted when clicking the previous button"
+  }
+}