docs(api): add missing descriptions (#20609)

Co-authored-by: Kael <[email protected]>

packages/api-generator/src/locale/en/VCalendar.json

@@ -1,7 +1,6 @@
 {
   "props": {
     "allowedDates": "Determines which dates are selectable.",
-    "displayValue": "Value to display for the component, possibly a formatted date.",
     "hideHeader": "Determines whether the header is hidden in the calendar view.",
     "hideWeekNumber": "Toggles the display of week numbers in a calendar view.",
     "intervals": "Total number of intervals in a day view.",
@@ -14,7 +13,8 @@
     "year": "Specifies the year for the calendar view."
   },
   "slots": {
-    "header": "Slot for custom header content."
+    "header": "Slot for custom header content.",
+    "event": "Slot for custom event content."
   },
   "events": {
     "next": "Emitted when moving to the next time period.",

packages/api-generator/src/locale/en/VConfirmEdit.json

@@ -5,6 +5,7 @@
   },
   "events": {
     "ok": "The event emitted when the user clicks the OK button",
+    "save": "The event emitted when the user clicks the Save button",
     "cancel": "The event emitted when the user clicks the Cancel button"
   }
 }

packages/api-generator/src/locale/en/VDataIterator.json

@@ -43,6 +43,7 @@
     "input": "Array of selected items.",
     "itemExpanded": "Event emitted when an item is expanded or closed.",
     "itemSelected": "Event emitted when an item is selected or deselected.",
+    "update:currentItems": "The `.sync` event for `currentItems` prop.",
     "update:expanded": "The `.sync` event for `expanded` prop.",
     "update:groupBy": "The `.sync` event for `groupBy` prop.",
     "update:itemsPerPage": "The `.sync` event for `itemsPerPage` prop.",

packages/api-generator/src/locale/en/VDataTable.json

@@ -38,7 +38,10 @@
     "virtualRows": "Virtualizes the rendering of rows. Be aware that you can not use the `body`, `body.prepend` or `body.append` slots with this prop."
   },
   "slots": {
+    "[`header.${string}`]": "Slot for custom rendering of a header cell.",
     "[`item.${string}`]": "Slot for custom rendering of a row cell.",
+    "header.data-table-expand": "Slot to replace the default `v-icon` used when expanding header.",
+    "header": "Slot to replace the default table `<thead>`.",
     "body": "Slot to replace the default table `<tbody>`.",
     "body.append": "Appends elements to the end of the default table `<tbody>`.",
     "body.prepend": "Prepends elements to the start of the default table `<tbody>`.",
@@ -55,11 +58,15 @@
     "heading": "Slot to add a custom header.",
     "header.<name>": "Slot to customize a specific header column.",
     "header.data-table-select": "Slot to replace the default `v-checkbox-btn` in header.",
+    "headers": "An array of objects that each describe a header column. See the example below for a definition of all properties.",
     "item": "Slot to replace the default rendering of a row.",
     "item.data-table-select": "Slot to replace the default `v-checkbox-btn` used when selecting rows.",
     "item.data-table-expand": "Slot to replace the default `v-icon` used when expanding rows.",
     "item.<name>": "Slot to customize a specific column.",
     "loading": "Defines content for when `loading` is true and no items are provided.",
+    "tbody": "Slot to replace the default table `<tbody>`.",
+    "thead": "Slot to replace the default table `<thead>`.",
+    "tfoot": "Slot to replace the default table `<tfoot>`.",
     "no-data": "Defines content for when no items are provided.",
     "no-results": "Defines content for when `search` is provided but no results are found.",
     "progress": "Slot to replace the default `<v-progress-linear>` component.",
@@ -73,6 +80,7 @@
     "pageCount": "Emits when the **pageCount** property of the **pagination** prop is updated.",
     "pagination": "Emits when something changed to the `pagination` which can be provided via the `pagination` prop.",
     "toggleSelectAll": "Emits when the `select-all` checkbox in table header is clicked. This checkbox is enabled by the **show-select** prop.",
+    "update:currentItems": "Emits with the items currently being displayed.",
     "update:expanded": "Emits when the **expanded** property of the **options** prop is updated.",
     "update:groupBy": "Emits when the **group-by** property of the **options** property is updated.",
     "update:groupDesc": "Emits when the **group-desc** property of the **options** prop is updated.",

packages/api-generator/src/locale/en/VDataTableFooter.json

@@ -12,5 +12,8 @@
     "prevIcon": "Previous icon.",
     "prevPageLabel": "Label for previous page.",
     "showCurrentPage": "Show current page number between prev/next icons."
+  },
+  "slots": {
+    "prepend": "Extra content placed before the default pagination."
   }
 }

packages/api-generator/src/locale/en/VDataTableRow.json

@@ -1,6 +1,16 @@
 {
   "props": {
+    "cellProps": "Props to be applied to the cell.",
     "index": "Row index.",
     "item": "Data (key, index and column values) of the displayed item."
+  },
+  "events": {
+    "contextmenu": "The event emitted when the user clicks the context menu button.",
+    "dblclick": "The event emitted when the user double clicks the row.",
+    "[`item.${string}`]": "The event emitted when the user clicks the item."
+  },
+  "slots": {
+    "item.data-table-expand": "Slot for the expand button in the row.",
+    "item.data-table-select": "Slot for the select checkbox in the row."
   }
 }

packages/api-generator/src/locale/en/VDataTableServer.json

@@ -1,11 +1,17 @@
 {
   "props": {
-    "itemsLength": "Number of all items."
+    "itemsLength": "Number of all items.",
+    "headerProps": "Pass props to the default header. See [`v-data-table-server` API](/api/v-data-table-server) for more information."
   },
   "slots": {
+    "[`header.${string}`]": "Slot for a specific header. See [`v-data-table-server` API](/api/v-data-table-server) for more information.",
     "[`column.${string}`]": "Slot for custom rendering of a column.",
     "[`item.${string}`]": "Slot for custom rendering of a row cell.",
     "body": "Slot to replace the default rendering of the `<tbody>` element.",
+    "body.append": "Adds content to the empty space in the body.",
+    "body.prepend": "Adds content to the empty space in the body.",
+    "header.data-table-expand": "Slot for the expand button in the header.",
+    "header.data-table-select": "Slot for the select-all checkbox in the header.",
     "bottom": "Slot to add content below the table.",
     "colgroup": "Slot to replace the default rendering of the `<colgroup>` element.",
     "column.data-table-expand": "Slot to replace the default `v-icon` used when expanding rows.",

packages/api-generator/src/locale/en/VDataTableVirtual.json

@@ -1,8 +1,16 @@
 {
+  "props": {
+    "headerProps": "Pass props to the default header."
+  },
   "slots": {
+    "[`header.${string}`]": "Slot for a specific header. See [`v-data-table-virtual` API](/api/v-data-table-virtual) for more information.",
     "[`column.${string}`]": "Slot for custom rendering of a column.",
     "[`item.${string}`]": "Slot for custom rendering of a row cell.",
+    "header.data-table-expand": "Slot for the expand button in the header.",
+    "header.data-table-select": "Slot for the select-all checkbox in the header.",
     "body": "Slot to replace the default rendering of the `<tbody>` element.",
+    "body.append": "Slot to add content below the table.",
+    "body.prepend": "Slot to add content above the table.",
     "bottom": "Slot to add content below the table.",
     "colgroup": "Slot to replace the default rendering of the `<colgroup>` element.",
     "column.data-table-expand": "Slot to replace the default `v-icon` used when expanding rows.",

packages/api-generator/src/locale/en/VDatePicker.json

@@ -7,6 +7,12 @@
     "eventColor": "Sets the color for event dot. It can be string (all events will have the same color) or `object` where attribute is the event date and value is boolean/color/array of colors for specified date or `function` taking date as a parameter and returning boolean/color/array of colors for that date.",
     "events": "Array of dates or object defining events or colors or function returning boolean/color/array of colors.",
     "expandIcon": "Icon used for **view-mode** toggle.",
+    "hideHeader": "Hides the header.",
+    "hideWeekdays": "Hides the weekdays.",
+    "landscape": "Changes the picker to landscape mode.",
+    "month": "Sets the month.",
+    "weekdays": "Array of weekdays.",
+    "year": "Sets the year.",
     "firstDayOfWeek": "Sets the first day of the week, starting with 0 for Sunday.",
     "flat": "Removes  elevation.",
     "format": "Takes a date object and returns it in a specified format.",
@@ -40,10 +46,17 @@
     "yearIcon": "Sets the icon in the year selection button."
   },
   "events": {
+    "update:month": "Emitted when the month changes.",
+    "update:year": "Emitted when the year changes.",
+    "update:viewMode": "Emitted when the view mode changes.",
     "<domevent>:date": "Emitted when the specified DOM event occurs on the date button.",
     "<domevent>:month": "Emitted when the specified DOM event occurs on the month button.",
     "<domevent>:year": "Emitted when the specified DOM event occurs on the year button.",
     "change": "Reactive date picker emits `input` even when any part of the date (year/month/day) changes, but `change` event is emitted only when the day (for date pickers) or month (for month pickers) changes. If `range` prop is set, date picker emits `change` when both [from, to] are selected.",
     "update:pickerDate": "The `.sync` event for `picker-date` prop."
+  },
+  "slots": {
+    "actions": "Slot for the actions.",
+    "header": "Slot for the header."
   }
 }

packages/api-generator/src/locale/en/VDatePickerControls.json

@@ -0,0 +1,15 @@
+{
+  "props": {
+    "modeIcon": "Icon used for the mode button.",
+    "nextIcon": "Icon used for the next button.",
+    "prevIcon": "Icon used for the previous button.",
+    "viewMode": "Sets the view mode of the date picker."
+  },
+  "events": {
+    "click:month": "Event fired when clicking on the month.",
+    "click:next": "Event fired when clicking the next button.",
+    "click:prev": "Event fired when clicking the previous button.",
+    "click:year": "Event fired when clicking the date text.",
+    "click:text": "Event fired when clicking the year."
+  }
+}

packages/api-generator/src/locale/en/VDatePickerHeader.json

@@ -0,0 +1,6 @@
+{
+  "props": {
+    "header": "Sets the header content.",
+    "transition": "Sets the transition when the header changes."
+  }
+}

packages/api-generator/src/locale/en/VDatePickerMonth.json

@@ -1,7 +1,21 @@
 {
   "props": {
+    "allowedDates": "Sets the allowed dates of the month.",
     "hideWeekdays": "Hide the days of the week letters.",
+    "max": "Sets the maximum date of the month.",
+    "min": "Sets the minimum date of the month.",
+    "month": "Sets the month.",
+    "weekdays": "Sets the weekdays of the month.",
+    "year": "Sets the year.",
+    "multiple": "Sets the multiple of the month.",
+    "showAdjacentMonths": "Show adjacent months.",
+    "showWeek": "Show the week number.",
     "transition": "The transition used when changing months into the future",
     "reverseTransition": "The transition used when changing months into the past"
+  },
+  "events": {
+    "update:month": "Fired when the month changes.",
+    "update:year": "Fired when the year changes.",
+    "day": "Fired when a day is clicked."
   }
 }

packages/api-generator/src/locale/en/VDatePickerMonths.json

@@ -0,0 +1,5 @@
+{
+  "slots": {
+    "month": "Slot for the month."
+  }
+}

packages/api-generator/src/locale/en/VDatePickerYear.json

@@ -0,0 +1,21 @@
+{
+  "props": {
+    "allowedDates": "Sets the allowed dates of the month.",
+    "hideWeekdays": "Hide the days of the week letters.",
+    "max": "Sets the maximum date of the month.",
+    "min": "Sets the minimum date of the month.",
+    "month": "Sets the month.",
+    "weekdays": "Sets the weekdays of the month.",
+    "year": "Sets the year.",
+    "day": "The current day of the selected date.",
+    "multiple": "Sets the multiple of the month.",
+    "showAdjacentMonths": "Show adjacent months.",
+    "showWeek": "Show the week number.",
+    "transition": "The transition used when changing months into the future",
+    "reverseTransition": "The transition used when changing months into the past"
+  },
+  "events": {
+    "update:month": "Event emitted when the month changes.",
+    "update:year": "Event emitted when the year changes."
+  }
+}

packages/api-generator/src/locale/en/VDatePickerYears.json

@@ -0,0 +1,7 @@
+{
+  "props": {
+    "max": "Sets the maximum date of the month.",
+    "min": "Sets the minimum date of the month.",
+    "year": "Sets the year."
+  }
+}

packages/api-generator/src/locale/en/VDialog.json

@@ -20,6 +20,7 @@
     "activatorEl": "Ref to the current activator element.",
     "animateClick": "Function invoked when user clicks outside the component and the **persistent** prop is used.",
     "contentEl": "Ref to the current content element.",
+    "scrimEl": "Ref to the current scrim element.",
     "globalTop": "Used by activator to determine a components position in the global stack order.",
     "localTop": "Used by activator to determine a components position in the local stack order.",
     "updateLocation": "Function used for locationStrategy positioning."

packages/api-generator/src/locale/en/VDialogTransition.json

@@ -1 +1,5 @@
-{}
+{
+  "props": {
+    "target": "Sets the target element for the transition."
+  }
+}

packages/api-generator/src/locale/en/VExpansionPanel.json

@@ -1,8 +1,10 @@
 {
   "props": {
     "disabled": "Disables the expansion-panel content.",
-    "readonly": "Makes the expansion-panel content read only.",
-    "value": "Controls the opened/closed state of content."
+    "readonly": "Makes the expansion panel content read only.",
+    "focusable": "Makes the expansion panel content focusable.",
+    "value": "Controls the opened/closed state of content.",
+    "static": "Remove title size expansion when selected."
   },
   "events": {
     "change": "Toggles the value of the selected panel.",

packages/api-generator/src/locale/en/VExpansionPanelTitle.json

@@ -3,6 +3,11 @@
     "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.",
-    "static": "Remove title size expansion when selected."
+    "static": "Remove title size expansion when selected.",
+    "focusable": "Makes the expansion panel headers focusable.",
+    "readonly": "Makes the expansion panel content read only."
+  },
+  "slots": {
+    "actions": "Slot for the actions."
   }
 }

packages/api-generator/src/locale/en/VExpansionPanels.json

@@ -5,9 +5,10 @@
     "focusable": "Makes the expansion-panel headers focusable.",
     "flat": "Removes the expansion-panel's elevation and borders.",
     "hover": "Applies a background-color shift on hover to expansion panel headers.",
-    "inset": "Makes the expansion-panel open with a inset style.",
+    "inset": "Makes the expansion panel open with a inset style.",
     "popout": "Makes the expansion-panel open with an popout style.",
-    "readonly": "Makes the entire expansion-panel read only.",
+    "readonly": "Makes the entire expansion panel read only.",
+    "static": "Remove title size expansion when selected.",
     "tile": "Removes the border-radius.",
     "value": "Controls the opened/closed state of content in the expansion-panel. Corresponds to a zero-based index of the currently opened content. If the `multiple` prop (previously `expand` in 1.5.x) is used then it is an array of numbers where each entry corresponds to the index of the opened content.  The index order is not relevant."
   }

packages/api-generator/src/locale/en/VImg.json

@@ -24,5 +24,12 @@
     "error": "Emitted if the image fails to load.",
     "load": "Emitted when the image is loaded.",
     "loadstart": "Emitted when the image starts to load."
+  },
+  "exposed": {
+    "currentSrc": "The current source of the image. This is the image that is currently being displayed. This is useful for determining if the image is loading or not.",
+    "image": "The image element.",
+    "naturalHeight": "The natural height of the image.",
+    "naturalWidth": "The natural width of the image.",
+    "state": "The current state of the image. This is useful for determining if the image is loading or not."
   }
 }

packages/api-generator/src/locale/en/VInput.json

@@ -27,6 +27,8 @@
     "mouseup": "Emitted when click is released."
   },
   "exposed": {
+    "errorMessages": "An array of error messages that were set by the `setErrors` method.",
+    "isValid": "Boolean indicating if the input is valid.",
     "reset": "Resets the input value.",
     "resetValidation": "Resets validation of the input without modifying its value.",
     "validate": "Validates the input's value."

packages/api-generator/src/locale/en/VLayoutItem.json

@@ -1 +1,5 @@
-{}
+{
+  "props": {
+    "position": "The position of the item."
+  }
+}

packages/api-generator/src/locale/en/VList.json

@@ -1,6 +1,7 @@
 {
   "props": {
     "itemType": "Designates the key on the supplied items that is used for determining the nodes type.",
+    "activatable": "Designates whether the list items are activatable.",
     "disabled": "Puts all children inputs into a disabled state.",
     "inactive": "If set, the list tile will not be rendered as a link even if it has to/href prop or @click handler.",
     "lines": "Designates a **minimum-height** for all children `v-list-item` components. This prop uses [line-clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp) and is not supported in all browsers.",
@@ -9,6 +10,24 @@
     "subheader": "Removes the top padding from `v-list-subheader` components. When used as a **String**, renders a subheader for you.",
     "slim": "Reduces horizontal spacing for badges, icons, tooltips, and avatars within slim list items to create a more compact visual representation.",
     "collapseIcon": "Icon to display when the list item is expanded.",
-    "expandIcon": "Icon to display when the list item is collapsed."
+    "expandIcon": "Icon to display when the list item is collapsed.",
+    "selectable": "Designates whether the list items are selectable."
+  },
+  "events": {
+    "click:activate": "Emitted when the list item is activated.",
+    "click:open": "Emitted when the list item is opened.",
+    "click:select": "Emitted when the list item is selected.",
+    "update:activated": "Emitted when the list item is activated.",
+    "update:opened": "Emitted when the list item is opened.",
+    "update:selected": "Emitted when the list item is selected."
+  },
+  "slots": {
+    "divider": "Slot for the divider.",
+    "header": "Slot for the header.",
+    "subheader": "Removes the top padding from `v-list-subheader` components. When used as a **String**, renders a subheader for you.",
+    "children": "Slot for the children.",
+    "focus": "Slot for the focus.",
+    "open": "Slot for the open.",
+    "parents": "Slot for the parents."
   }
 }

packages/api-generator/src/locale/en/VListGroup.json

@@ -7,7 +7,8 @@
     "noAction": "Removes left padding assigned for action icons from group items.",
     "prependIcon": "Prepends an icon to the component, uses the same syntax as `v-icon`.",
     "subgroup": "Designate the component as nested list group.",
-    "value": "Expands / Collapse the list-group."
+    "value": "Expands / Collapse the list-group.",
+    "fluid": "Removes the left padding assigned for action icons from group items."
   },
   "exposed": {
     "isOpen": "Returns the current state of the list-group."

packages/api-generator/src/locale/en/VListSubheader.json

@@ -1 +1,8 @@
-{}
+{
+  "props": {
+    "tag": "Specify a custom tag used on the root element.",
+    "title": "Specify a title text for the component.",
+    "inset": "Insets the subheader without additional spacing, aligning it flush with the surrounding content.",
+    "sticky": "Sticks the header to the top of the table."
+  }
+}