Skip to content

Commit 43b8f83

Browse files
committed
docs(VDataTable, VDataIterator): some cleanup in API descriptions
1 parent 3983af9 commit 43b8f83

File tree

3 files changed

+17
-29
lines changed

3 files changed

+17
-29
lines changed
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"props": {
3-
"expanded": "Whether the item is expanded or not.",
3+
"expanded": "Array of expanded items. Can be bound to external variable using **v-model:expanded**.",
44
"expandOnClick": "Expands item when the row is clicked.",
55
"showExpand": "Shows the expand icon."
6+
},
7+
"events": {
8+
"update:expanded": "Emits when the **expanded** items are updated."
69
}
710
}

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
"disableFiltering": "Disables filtering completely.",
77
"disablePagination": "Disables pagination completely.",
88
"disableSort": "Disables sorting completely.",
9-
"expanded": "Array of expanded items. Can be used with `.sync` modifier.",
9+
"expanded": "Array of expanded items. Can be bound to external variable using **v-model:expanded**.",
1010
"footerProps": "See the [`v-data-footer`](/api/v-data-footer) API for more information.",
1111
"groupBy": "Configures attributes (and sort order) to group items together.",
1212
"hideDefaultFooter": "Hides default footer.",
1313
"itemKey": "The property on each item that is used as a unique key.",
14-
"itemsPerPage": "Changes how many items per page should be visible. Can be used with `.sync` modifier. Setting this prop to `-1` will display all items on the page.",
14+
"itemsPerPage": "Changes how many items per page should be visible. Can be bound to external variable using **v-model:itemsPerPage**.. Setting this prop to `-1` will display all items on the page.",
1515
"loading": "If `true` and no items are provided, then a loading text will be shown.",
1616
"loadingText": "Text shown when `loading` is true and no items are provided.",
1717
"locale": "Sets the locale used for sorting. This is passed into [`Intl.Collator()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator) in the default `customSort` function.",
@@ -24,8 +24,7 @@
2424
"serverItemsLength": "Used only when data is provided by a server. Should be set to the total amount of items available on server so that pagination works correctly.",
2525
"singleExpand": "Changes expansion mode to single expand.",
2626
"singleSelect": "Changes selection mode to single select.",
27-
"sortBy": "Changes which item property (or properties) should be used for sort order. Can be used with `.sync` modifier.",
28-
"sortDesc": "Changes which direction sorting is done. Can be used with `.sync` modifier.",
27+
"sortBy": "Changes which item property (or properties) should be used for sort order. Can be bound to external variable using **v-model:sortBy**.",
2928
"value": "Used for controlling selected rows."
3029
},
3130
"slots": {
@@ -39,15 +38,12 @@
3938
"no-results": "Defines content for when `search` is provided but no results are found."
4039
},
4140
"events": {
42-
"input": "Array of selected items.",
43-
"itemExpanded": "Event emitted when an item is expanded or closed.",
44-
"itemSelected": "Event emitted when an item is selected or deselected.",
45-
"update:currentItems": "The `.sync` event for `currentItems` prop.",
46-
"update:expanded": "The `.sync` event for `expanded` prop.",
47-
"update:groupBy": "The `.sync` event for `groupBy` prop.",
48-
"update:itemsPerPage": "The `.sync` event for `itemsPerPage` prop.",
49-
"update:options": "The `.sync` event for `options` prop.",
50-
"update:page": "The `.sync` event for `page` prop.",
51-
"update:sortBy": "The `.sync` event for `sortBy` prop."
41+
"update:currentItems": "Emits with the items currently being displayed.",
42+
"update:expanded": "Emits when the **expanded** items are updated.",
43+
"update:groupBy": "Emits when the **group-by** prop is updated.",
44+
"update:itemsPerPage": "Emits when the **items-per-page** prop is updated.",
45+
"update:options": "Emits when pagination related properties (page, itemsPerPage, sortBy, groupBy, search) is updated.",
46+
"update:page": "Emits when the **page** prop is updated.",
47+
"update:sortBy": "Emits when the **sortBy** prop is updated."
5248
}
5349
}

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

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
"checkboxColor": "Set the color of the checkboxes (showSelect must be used).",
55
"collapseIcon": "Icon to display when the expandable row is expanded.",
66
"customFilter": "Function to filter items.",
7-
"customGroup": "Function used to group items.",
8-
"customSort": "Function used to sort items.",
97
"caption": "Set the caption (using `<caption>`).",
108
"density": "Adjusts the vertical height of the table rows.",
119
"disableFiltering": "Disables filtering completely.",
@@ -22,7 +20,7 @@
2220
"height": "Set an explicit height of table.",
2321
"hover": "Adds a hover effects to a table rows.",
2422
"itemClass": "Property on supplied `items` that contains item's row class or function that takes an item as an argument and returns the class of corresponding row.",
25-
"itemsPerPage": "Changes how many items per page should be visible. Can be used with `.sync` modifier. Setting this prop to `-1` will display all items on the page.",
23+
"itemsPerPage": "Changes how many items per page should be visible. Can be bound to external variable using **v-model:itemsPerPage**.. Setting this prop to `-1` will display all items on the page.",
2624
"locale": "Sets the locale used for sorting. This is passed into [`Intl.Collator()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator) in the default `customSort` function.",
2725
"multiSort": "If `true` then one can sort on multiple properties.",
2826
"mustSort": "If `true` then one can not disable sorting, it will always switch between ascending and descending.",
@@ -31,8 +29,7 @@
3129
"showSelect": "Shows the select checkboxes in both the header and rows (if using default rows).",
3230
"showExpand": "Shows the expand toggle in default rows.",
3331
"showGroupBy": "Shows the group by toggle in the header and enables grouped rows.",
34-
"sortBy": "Changes which item property (or properties) should be used for sort order. Can be used with `.sync` modifier.",
35-
"sortDesc": "Changes which direction sorting is done. Can be used with `.sync` modifier.",
32+
"sortBy": "Changes which item property (or properties) should be used for sort order. Can be bound to external variable using **v-model:sortBy**..",
3633
"virtualRows": "Virtualizes the rendering of rows. Be aware that you can not use the `body`, `body.prepend` or `body.append` slots with this prop."
3734
},
3835
"slots": {
@@ -74,20 +71,12 @@
7471
"click:row": "Emits when a table row is clicked. This event provides 2 arguments: the first is the native click event, and the second is an object containing the corresponding item for that row. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.",
7572
"contextmenu:row": "Emits when a table row is right-clicked. The item for the row is included. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.",
7673
"dblclick:row": "Emits when a table row is double-clicked. The item for the row is included. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.",
77-
"currentItems": "Emits the items provided via the **items** prop, every time the internal **computedItems** is changed.",
78-
"pageCount": "Emits when the **pageCount** property of the **pagination** prop is updated.",
79-
"pagination": "Emits when something changed to the `pagination` which can be provided via the `pagination` prop.",
80-
"toggleSelectAll": "Emits when the `select-all` checkbox in table header is clicked. This checkbox is enabled by the **show-select** prop.",
8174
"update:currentItems": "Emits with the items currently being displayed.",
82-
"update:expanded": "Emits when the **expanded** prop is updated.",
8375
"update:groupBy": "Emits when the **group-by** prop is updated.",
8476
"update:itemsPerPage": "Emits when the **items-per-page** prop is updated.",
8577
"update:modelValue": "Emits when the component's model changes.",
86-
"update:multiSort": "Emits when the **multi-sort** prop is updated.",
87-
"update:mustSort": "Emits when the **must-sort** prop is updated.",
8878
"update:options": "Emits when pagination related properties (page, itemsPerPage, sortBy, groupBy, search) is updated.",
8979
"update:page": "Emits when the **page** prop is updated.",
90-
"update:sortBy": "Emits when the **sortBy** prop is updated.",
91-
"update:sortDesc": "Emits when the **sort-desc** prop is updated."
80+
"update:sortBy": "Emits when the **sortBy** prop is updated."
9281
}
9382
}

0 commit comments

Comments
 (0)