@nativescript-community/ui-collectionview

Allows you to easily add a collection view (grid list view) to your projects. Supports vertical and horizontal modes, templating, and more.

| | |
| --- | ----------- |
| iOS Demo | Android Demo |

[](#table-of-contents)

Table of Contents

* Installation
* API
* Events
* Properties
* Methods
* Usage
* Simple Example
* Templates Example
* Usage in Angular
* Simple Example
* Templates Example
* Usage in Vue 3
* Simple Example
* Usage in Vue 2
* Simple Example
* Usage in Svelte
* Simple Example
* Usage in React
* Simple Example
* Demos
* Demos and Development
* Repo Setup
* Build
* Demos
* Contributing
* Update repo
* Update readme
* Update doc
* Publish
* modifying submodules
* Questions

[](#installation)

Installation

Run the following command from the root of your project:

ns plugin add @nativescript-community/ui-collectionview

[](#api)

API

$3

| Property | Description |
| ------------------- | ---------------------------------------------------------------------------- |
| itemLoading | Triggered when generating an item in the CollectionView. |
| itemTap | Triggered when the user taps on an item in the CollectionView. |
| loadMoreItems | Triggered when the generated items reached the end of the items property. |
| scroll | Triggered on collectionview scroll. |
| scrollEnd | Triggered on collectionview scroll end. |
| itemReorderStarting | Triggered when a reorder is starting. Changing the returnValue of the event data allows you to cancel it |
| itemReorderStarted | Triggered when a reorder started. |
| itemReordered | Triggered when a reorder finished. |
| dataPopulated | Triggered when a refresh has been called. |

$3

| Property | Type | Description |
| ------------- | ------------------------------------------------ | ------------------------------------------------------- |
| ios | UICollectionView | Gets the native iOS view that represents the user interface for this component. Valid only when running on iOS. |
| android | android.support.v7.widget.RecyclerView | Gets the native android widget that represents the user interface for this component. Valid only when running on Android OS. |
| items | array or ItemsSource | Gets or sets the items collection of the CollectionView. The items property can be set to an array or an object defining length and getItem(index) method. |
| itemTemplate | string | Gets or sets the item template of the CollectionView. |
| rowHeight | PercentLength | Gets or sets the height for every row in the CollectionView. |
| colWidth | PercentLength | Gets or sets the width for every column in the CollectionView. |
| spanSize | function | Triggered when an item is loaded. Returns the number of columns that the element should occupy taking into account colWidth when the device is vertical and rowHeight when horizontal. Parameters: (item, index: number). |
| scrollOffset | number | Gets the current scroll. |
| orientation | vertical or horizontal | Sets the orientation of the CollectionView. Defaults to vertical. |

$3

| Name | Return | Description |
| ------------------------------------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------- |
| refresh() | void | Forces the CollectionView to reload all its items. |
| refreshVisibleItem() | void | Forces CollectionView to reload visible items. |
| scrollToIndex(index: number, animated: boolean = true) | void | Scrolls the CollectionView to the item with the given index. This can be either animated or not. Defaults to animated. |
| isItemAtIndexVisible(index: number) | boolean | Returns a boolean indicating whether the item is visible. |

[](#usage)

Usage

You need to add xmlns:gv="@nativescript-community/ui-collectionview" to your page tag, and then simply use in order to add the widget to your page. Use to specify the template for each cell:

$3

Create a simple array of objects in your JS/TS file.

``typescript
const items = [
{ index: 0, name: 'TURQUOISE', color: '#1abc9c' },
{ index: 1, name: 'EMERALD', color: '#2ecc71' },
{ index: 2, name: 'PETER RIVER', color: '#3498db' },
{ index: 3, name: 'AMETHYST', color: '#9b59b6' },
{ index: 4, name: 'WET ASPHALT', color: '#34495e' },
{ index: 5, name: 'GREEN SEA', color: '#16a085' },
{ index: 6, name: 'NEPHRITIS', color: '#27ae60' },
{ index: 7, name: 'BELIZE HOLE', color: '#2980b9' },
{ index: 8, name: 'WISTERIA', color: '#8e44ad' },
{ index: 9, name: 'MIDNIGHT BLUE', color: '#2c3e50' }
];
`

`xml










`

$3


You can also have multiple templates the same way you add them in the builtin ListView control:
`xml
colWidth="colWidth" rowHeight="rowHeight" itemTemplateSelector="templateSelector"
itemTap="gridViewItemTap" itemLoading="gridViewItemLoading" loadMoreItems="gridViewLoadMoreItems">




`
`ts
export function templateSelector(item: any, index: number, items: any) {
return index % 2 === 0 ? "even" : "odd";
}
`


[](#usage-in-angular)



Usage in Angular

Import the module into your project.

`typescript
import { CollectionViewModule } from '@nativescript-community/ui-collectionview/angular';

@NgModule({
imports: [
CollectionViewModule,
],
})
`


$3

Create a simple array of objects in your Typescript file.

`typescript
items = [
{ index: 0, name: 'TURQUOISE', color: '#1abc9c' },
{ index: 1, name: 'EMERALD', color: '#2ecc71' },
{ index: 2, name: 'PETER RIVER', color: '#3498db' },
{ index: 3, name: 'AMETHYST', color: '#9b59b6' },
{ index: 4, name: 'WET ASPHALT', color: '#34495e' },
{ index: 5, name: 'GREEN SEA', color: '#16a085' },
{ index: 6, name: 'NEPHRITIS', color: '#27ae60' },
{ index: 7, name: 'BELIZE HOLE', color: '#2980b9' },
{ index: 8, name: 'WISTERIA', color: '#8e44ad' },
{ index: 9, name: 'MIDNIGHT BLUE', color: '#2c3e50' }
];
`

Add the following to your component HTML.
`xml





`

$3


If you want to use multiple item templates, you can do that very similarly to how you do it for the builtin ListView control. The only difference is that due to current limitations instead of using the nsTemplateKey directive you need to use the cvTemplateKey directive that comes from the CollectionView. (In a future version, once the framework allows it this will be changed and you will be able to use the same directive for the CollectionView as well)
`html







`

For a more complete example, look in the demo-ng directory.


[](#usage-in-vue-3)



Usage in Vue 3

Register the plugin in your app.ts.

`ts
import CollectionView from '@nativescript-community/ui-collectionview/vue3';

const app = createApp(YourComponent);
app.use(CollectionView);
app.start();
`

$3

In your component, add the following to make a simple array of objects.

`html

`

Then add the following XML to your component.

`xml



`

For a more complete example, look in the demo-vue3 and demo-snippets/vue3 directory.


[](#usage-in-vue-2)



Usage in Vue 2

Register the plugin in your app.ts.

`typescript
import CollectionView from '@nativescript-community/ui-collectionview/vue';
Vue.use(CollectionView);
`

$3

In your component, add the following to make a simple array of objects.

`typescript
export default {
// ...
data() {
const items = [
{ index: 0, name: 'TURQUOISE', color: '#1abc9c' },
{ index: 1, name: 'EMERALD', color: '#2ecc71' },
{ index: 2, name: 'PETER RIVER', color: '#3498db' },
{ index: 3, name: 'AMETHYST', color: '#9b59b6' },
{ index: 4, name: 'WET ASPHALT', color: '#34495e' },
{ index: 5, name: 'GREEN SEA', color: '#16a085' },
{ index: 6, name: 'NEPHRITIS', color: '#27ae60' },
{ index: 7, name: 'BELIZE HOLE', color: '#2980b9' },
{ index: 8, name: 'WISTERIA', color: '#8e44ad' },
{ index: 9, name: 'MIDNIGHT BLUE', color: '#2c3e50' }
];
return {
itemList: items
};
},
// ...
};
`

Then add the following XML to your component.

`xml
:items="itemList"
colWidth="50%"
rowHeight="100"
>




`

For a more complete example, look in the demo-vue directory.


[](#usage-in-svelte)



Usage in Svelte

Register the plugin in your app.ts.

`typescript
import CollectionViewElement from '@nativescript-community/ui-collectionview/svelte';
CollectionViewElement.register();
`

$3

In you component, add the following to import Svelte Templates and to create a simple array of objects.

`typescript
import { Template } from '@nativescript-community/svelte-native/components';

const items = [
{ index: 0, name: 'TURQUOISE', color: '#1abc9c' },
{ index: 1, name: 'EMERALD', color: '#2ecc71' },
{ index: 2, name: 'PETER RIVER', color: '#3498db' },
{ index: 3, name: 'AMETHYST', color: '#9b59b6' },
{ index: 4, name: 'WET ASPHALT', color: '#34495e' },
{ index: 5, name: 'GREEN SEA', color: '#16a085' },
{ index: 6, name: 'NEPHRITIS', color: '#27ae60' },
{ index: 7, name: 'BELIZE HOLE', color: '#2980b9' },
{ index: 8, name: 'WISTERIA', color: '#8e44ad' },
{ index: 9, name: 'MIDNIGHT BLUE', color: '#2c3e50' }
];
`

Then add the following XML to your component:

`xml
{items}
colWidth="50%"
rowHeight="100"
>


`

For a more complete example, look in the demo-svelte directory.


[](#usage-in-react)



Usage in React

Register the plugin in your app.ts.

`typescript
import { registerCollectionView } from '@nativescript-community/ui-collectionview/react';
registerCollectionView();
`

$3

In your component, add the following code to create a simple list.

`tsx
import { CollectionView } from '@nativescript-community/ui-collectionview/react';

const items = [
{ index: 0, name: 'TURQUOISE', color: '#1abc9c' },
{ index: 1, name: 'EMERALD', color: '#2ecc71' },
{ index: 2, name: 'PETER RIVER', color: '#3498db' },
{ index: 3, name: 'AMETHYST', color: '#9b59b6' },
{ index: 4, name: 'WET ASPHALT', color: '#34495e' },
{ index: 5, name: 'GREEN SEA', color: '#16a085' },
{ index: 6, name: 'NEPHRITIS', color: '#27ae60' },
{ index: 7, name: 'BELIZE HOLE', color: '#2980b9' },
{ index: 8, name: 'WISTERIA', color: '#8e44ad' },
{ index: 9, name: 'MIDNIGHT BLUE', color: '#2c3e50' }
];

interface Item {
index: number;
name: string;
color: string;
}

const cellFactory = (item: Item) => (

);

export function First() {
return (

);
}
`

For a more complete example, look in the demo-react directory.


[](#demos)



Demos


This repository includes Angular, Vue.js, and Svelte demos. In order to run these execute the following in your shell:
`shell
$ git clone https://github.com/@nativescript-community/ui-collectionview
$ cd ui-collectionview
$ npm i
$ npm run setup
$ npm run build # && npm run build.angular
$ cd demo-ng # or demo-vue or demo-svelte
$ ns run ios|android
`

[](#demos-and-development)

Demos and Development

$3

The repo uses submodules. If you did not clone with --recursive then you need to call
`
git submodule update --init
`

The package manager used to install and link dependencies must be pnpm or yarn. npm wont work.

To develop and test:
if you use yarn then run yarn
if you use pnpm then run pnpm i

Interactive Menu:

To start the interactive menu, run npm start (or yarn start or pnpm start). This will list all of the commonly used scripts.

$3

`bash
npm run build.all
`
WARNING: it seems yarn build.all wont always work (not finding binaries in node_modules/.bin) which is why the doc explicitly uses npm run

$3

`bash
npm run demo.[ng|react|svelte|vue].[ios|android]

npm run demo.svelte.ios # Example
`

Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in demo-[ng|react|svelte|vue]
Instead you work in demo-snippets/[ng|react|svelte|vue]
You can start from the install.ts of each flavor to see how to register new demos


[](#contributing)



Contributing

$3

You can update the repo files quite easily

First update the submodules

`bash
npm run update
`

Then commit the changes
Then update common files

`bash
npm run sync
`
Then you can run yarn|pnpm, commit changed files if any

$3


`bash
npm run readme
`

$3

`bash
npm run doc
`

$3

The publishing is completely handled by lerna (you can add -- --bump major to force a major release)
Simply run
`shell
npm run publish
`

$3

The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
One easy solution is t modify ~/.gitconfig and add
`
[url "ssh://git@github.com/"]
pushInsteadOf = https://github.com/
``

[](#questions)

Questions

If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.