# vue-virtual-collection [![npm version](https://badge.fury.io/js/vue-virtual-collection.svg)](https://badge.fury.io/js/vue-virtual-collection) [![Build Status](https://travis-ci.org/starkwang/vue-virtual-collection.svg?branch=master)](https://travis-ci.org/starkwang/vue-virtual-collection) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![npm](https://img.shields.io/npm/dt/vue-virtual-collection.svg)](https://www.npmjs.com/package/vue-virtual-collection) Vue component for efficiently rendering large collection data. Inspired by [react-virtualize](https://github.com/bvaughn/react-virtualized). [Demo](https://starkwang.github.io/vue-virtual-collection/demo/dist/index.html) ![Demo](https://starkwang.github.io/vue-virtual-collection/img/demo.png) **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - [Usage](#usage) - [Install](#install) - [Import](#import) - [Use it!](#use-it) - [Default Usage](#default-usage) - [Item Grouping](#item-grouping) - [Props](#props) - [cellSizeAndPositionGetter](#cellsizeandpositiongetter) - [collection](#collection) - [width](#width) - [height](#height) - [scrollToBottomRange](#scrolltobottomrange) - [containerPaddingBottom](#containerpaddingbottom) - [headerSlotHeight](#headerslotheight) - [sectionSize](#sectionsize) - [Events](#events) - [scrolled-to-top](#scrolled-to-top) - [scrolled-to-bottom](#scrolled-to-bottom) - [scrolled-to-bottom-range](#scrolled-to-bottom-range) - [Slots](#slots) - [header](#header) - [cell](#cell) # Usage ## Install ``` npm i vue-virtual-collection ``` ## Import ```js import Vue from 'vue' import VirtualCollection from 'vue-virtual-collection' Vue.use(VirtualCollection) ``` ## Use it! `vue-virtual-collection` offers two ways of using a `VirtualCollection`. ### Default Usage The standard way of using a `VirtualCollection` is to to pass the entire collection of items to it as a single group. This is suitable for most cases, especially if all the items in the collection are either very similar or very different from one another. In the sample below, the collection is instantiated as an `Array` and passed directly to the `VirtualCollection` in that form. ```html ``` ### Item Grouping Item grouping is an optional feature that can be used to potentially improve performance, and is ideally suited to cases where the collection of items to render are logically divisable into a small number of different categories that may be updated, added or removed at different rates. Instead of passing the entire collection as an array to the `VirtualCollection`, the collection is passed as an array of "groups" - objects that each contain a subset of the entire collection's items that should logically be handled the same way. An example of where this might be appropriate is using `VirtualCollection` to represent a chess game. In this scenario, there might be separate items within the collection to represent the chessboard tiles and the chess pieces. Chessboard tiles and chess pieces are logically distinct categories of items, and each category would update at different rates; the collection of chessboard tiles would never change after being initially rendered, whereas the collection of pieces would change after every move. Without grouping, changing the position of a piece (or adding/removing one) would cause everything in the collection to be re-processed and potentially re-rendered, including the chessboard tiles. However, if we pass the pieces and the tiles as separate groups, then `VirtualCollection` will only reprocess the collection of chess pieces after each turn, and skip reprocessing the chessboard tiles. ```html ``` ## Props ### cellSizeAndPositionGetter Type: `Function` `(item: object, index: number) -> ({ height: number, width: number, x: number, y: number })` **Required: ✓** Callback responsible for returning size and offset/position information for a given cell ```js function cellSizeAndPositionGetter(item, index) { return { width: item.width, height: item.height, x: item.x, y: item.y } } ``` **Alternate usage** If using the item grouping feature, the second parameter is the index of the item within the group it belongs to and a third parameter represents the index of the group within the collection of groups passed to `VirtualCollection`. `(item: object, itemIndex: number, groupIndex: number) -> ({ height: number, width: number, x: number, y: number })` ```js function cellSizeAndPositionGetter(item, itemIndex, groupIndex) { return { width: item.width, height: item.height, x: item.x, y: item.y } } ``` ### collection Type: `Array` **Required: ✓** The data for cells to render. Each object in array must contain a `data` property, which will be passed into slot scope. ```js const collection = [ { data: { text: "#1" } }, { data: { text: "#2" } }, { data: { text: "#3" } }, // ... ] ``` **Alternate usage** If using the item grouping feature, each element of the collection should be an object with a `group` property representing a group of logically-related items. Each item of each group must contain a `data` property, which will be passed into slot scope. ```js const collection = [ { group: [ { data: { text: "#1" } }, { data: { text: "#2" } }, { data: { text: "#3" } }, // ... ] }, { group: [ { data: { text: "#A" } }, { data: { text: "#B" } }, { data: { text: "#C" } }, // ... ] }, // ... ] ``` ### width Type: `number` **Required: ✓** The width of collection viewport ### height Type: `number` **Required: ✓** The height of collection viewport ### scrollToBottomRange Type: `number` Default: undefined When present the component will emit `scrolled-to-bottom-range` when the bottom is >= 1 and the number provided. The `scrolled-to-bottom` will still be fired, and the 2 events will not be emitted at the same time. ### containerPaddingBottom Type: `number` Default: 0 Optionally extend the calculated height of the collection container, the affect is apparent padding-bottom ### headerSlotHeight Type: `number` Default: 0 When injecting content into the header slot, you should also add the px height of the slot. This ensure items are removed from view at the right time. ### sectionSize Type: `number` Default: 300 Optionally override the size of the sections a Collection's cells are split into. This is an advanced option and should only be used for performance tuning purposes. ## Events ### scrolled-to-top This event is emitted when the container scrollTop is reduced to 0. ### scrolled-to-bottom This event is emitted when the container scrollTop has reach the bottom. ### scrolled-to-bottom-range This event is emitted only when a `scrollToBottomRange` value is provided, and is fired when the container is scroller with range of the bottom, the range defined by the said prop. ## Slots ### header The header slot allows you to simulate a full-page mode for the virtual-scroller content. By setting the VirtualCollection height and width to be that of the browser window, the header will then sit on top of the scrollable items however will move out of view when the VirtualCollection is scrolled down. ```html

``` ### cell ```html

``` *The `data` property in items of `collection` will be passed into the slot scope.* ```js const collection = [ { data: { text: "#1" } }, { data: { text: "#2" } }, { data: { text: "#3" } }, // ... ] ```

vue-virtual-collection

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Sick of boring JavaScript newsletters?

Downloads in past