packages/api-generator/src/locale/en/VDataIterator.json - master - githubmirror/vuetify

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

28 строк2 KB

Rambaud Pierrick

docs: add description to all the component in the web-types (#22563)

22 апр 2026, 19:19

22 апр 2026, 19:1901b0a53

{
  "description": "Used for displaying arbitrary data, and shares a majority of its functionality with the `v-data-table` component.",
  "props": {
    "customFilter": "Function to filter items.",
    "expanded": "Array of expanded items. Can be bound to external variable using **v-model:expanded**.",
    "groupBy": "Configures attributes (and sort order) to group items together.",
    "initialSortOrder": "Specifies the initial sort order when an **toggleSort** is called for unsorted property.",
    "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.",
    "itemsLength": "The total number of items. Useful when using server-side pagination to correctly compute page counts.",
    "loading": "If `true` and no items are provided, then a loading text will be shown.",
    "search": "Text input used to filter items."
  },
  "slots": {
    "default": "The default slot. Use this to render your items.",
    "footer": "Defines a footer below the items.",
    "header": "Defines a header above the items.",
    "no-data": "Defines content for when no items are provided."
  },
  "events": {
    "update:currentItems": "Emits with the items currently being displayed.",
    "update:expanded": "Emits when the **expanded** items are updated.",
    "update:groupBy": "Emits when the **group-by** prop is updated.",
    "update:itemsPerPage": "Emits when the **items-per-page** prop is updated.",
    "update:options": "Emits when pagination related properties (page, itemsPerPage, sortBy, groupBy, search) is updated.",
    "update:page": "Emits when the **page** prop is updated.",
    "update:sortBy": "Emits when the **sortBy** prop is updated."
  }
}