VDataIterator API
组件页面
属性
| 名称 | 类型 | 默认值 |
|---|---|---|
| custom-filter | ||
| Function to filter items. | ||
| custom-key-filter | ||
| Function used on specific keys within the item object. customFilter is skipped for columns with customKeyFilter specified. | ||
| custom-key-sort | ||
| Function used on specific keys within the item object. customSort is skipped for columns with customKeySort specified. | ||
| expand-on-click | ||
| Expands item when the row is clicked. | ||
| expanded | ||
| Array of expanded items. Can be used with .sync modifier. | ||
| filter-keys | ||
| Array of specific keys to filter on the item. | ||
| filter-mode | ||
| Controls how the results of customFilter and customKeyFilter are combined. All modes only apply customFilter to columns not specified in customKeyFilter. some: There is at least one match from either the custom filter or the custom key filter. every: All columns match either the custom filter or the custom key filter. union: There is at least one match from the custom filter, or all columns match the custom key filters. intersection: There is at least one match from the custom filter, and all columns match the custom key filters. | ||
| group-by | ||
| Changes which item property should be used for grouping items. Currently only supports a single grouping in the format: group or ['group']. When using an array, only the first element is considered. Can be used with .sync modifier. | ||
| item-selectable | ||
| Property on supplied items that contains the boolean value indicating if the item is selectable. | ||
| item-value | ||
| Property on supplied items that contains its value. | ||
| items | ||
| An array of strings or objects used for automatically generating children components. | ||
| items-per-page | ||
| 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. | ||
| loading | ||
| If true and no items are provided, then a loading text will be shown. | ||
| model-value | ||
| The v-model value of the component. If component supports the multiple prop, this defaults to an empty array. | ||
| multi-sort | ||
| If true then one can sort on multiple properties. | ||
| must-sort | ||
| If true then one can not disable sorting, it will always switch between ascending and descending. | ||
| no-filter | ||
| Disables all item filtering. | ||
| page | ||
| The current displayed page number (1-indexed). | ||
| return-object | ||
| Changes the selection behavior to return the object directly rather than the value specified with item-value. | ||
| search | ||
| Text input used to filter items. | ||
| select-strategy | ||
| Defines the strategy of selecting items in the list. Possible values are: ‘single’ (only one item can be selected at a time), ‘page’ (‘Select all’ button will select only items on the current page), ‘all’ (‘Select all’ button will select all items in the list). | ||
| show-expand | ||
| Shows the expand icon. | ||
| show-select | ||
| Shows the column with checkboxes for selecting items in the list. | ||
| sort-by | ||
| Changes which item property (or properties) should be used for sort order. Can be used with .sync modifier. | ||
| tag | ||
| Specify a custom tag used on the root element. | ||
| transition | ||
| Sets the component transition. Can be one of the built in or custom transition. | ||
| value-comparator | ||
| Apply a custom comparison algorithm to compare model-value and values contains in the items prop. | ||
事件
| 名称 | 类型 |
|---|---|
| update:currentItems | |
| MISSING DESCRIPTION (edit in github ) | |
| update:expanded | |
| The .sync event for expanded prop. | |
| update:groupBy | |
| The .sync event for groupBy prop. | |
| update:itemsPerPage | |
| The .sync event for itemsPerPage prop. | |
| update:modelValue | |
| Event that is emitted when the component’s model changes. | |
| update:options | |
| The .sync event for options prop. | |
| update:page | |
| The .sync event for page prop. | |
| update:sortBy | |
| The .sync event for sortBy prop. | |
插槽
| default |
| The default slot. Use this to render your items. |
| footer |
| Defines a footer below the items. |
| header |
| Defines a header above the items. |
| loader |
| Slot for custom loader (displayed when loading prop is equal to true). |
| no-data |
| Defines content for when no items are provided. |