Documentation

This monorepo contains multiple packages:

alignedflowlayout

@nativescript-community/ui-collectionview-alignedflowlayout

A NativeScript CollectionView For Custom aligned Layout Plugin.

Installation
Configuration
Demos and Development
- Repo Setup
- Build
- Demos
Contributing
Questions

Installation

Run the following command from the root of your project:

ns plugin add @nativescript-community/ui-collectionview-alignedflowlayout

Configuration

To install the plugin run:

import install from '@nativescript-community/ui-collectionview-alignedflowlayout';
install();

then simply use the layoutStyle="align" as a collectionview property You can then use layoutHorizontalAlignment(left, right, justified) and verticalHorizontalAlignment (top, bottom, center)

Demos and Development

Repo Setup

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.

Build

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

Demos

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

npm run demo.svelte.ios # Example

Contributing

Update repo

You can update the repo files quite easily

First update the submodules

npm run update

Then commit the changes Then update common files

npm run sync

Then you can run yarn|pnpm, commit changed files if any

Update readme

npm run readme

Update doc

npm run doc

Publish

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

npm run publish

modifying submodules

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

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

collectionview

@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

Installation
API
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
Questions

Installation

Run the following command from the root of your project:

ns plugin add @nativescript-community/ui-collectionview

API

Events

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.

Properties

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`.

Methods

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

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

Simple Example

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

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' }
];

Templates Example

You can also have multiple templates the same way you add them in the builtin ListView control:

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

Usage in Angular

Import the module into your project.

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

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

Simple Example

Create a simple array of objects in your Typescript file.

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.

Templates Example

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)

<CollectionView row="1" [items]="items" colWidth="33%" rowHeight="100" [itemTemplateSelector]="templateSelector">
    <ng-template cvTemplateKey="Defender" let-item="item" let-odd="odd">
        <StackLayout [nsRouterLink]="['/item', item.id]" borderColor="blue" borderWidth="2" borderRadius="5" verticalAlignment="stretch" class="list-group-item" [class.odd]="odd">
        <Label verticalAlignment="center" [text]="item.name" class="list-group-item-text" textWrap="true"></Label>
        </StackLayout>
    </ng-template>

    <ng-template cvTemplateKey="Goalkeeper" let-item="item" let-odd="odd">
        <StackLayout [nsRouterLink]="['/item', item.id]" borderColor="black" borderWidth="2" borderRadius="5" verticalAlignment="stretch" class="list-group-item" [class.odd]="odd">
        <Label verticalAlignment="center" [text]="item.name" class="list-group-item-text" textWrap="true"></Label>
        </StackLayout>
    </ng-template>

    <ng-template cvTemplateKey="Midfielder" let-item="item" let-odd="odd">
        <StackLayout [nsRouterLink]="['/item', item.id]" borderColor="yellow" borderWidth="2" borderRadius="5" verticalAlignment="stretch" class="list-group-item" [class.odd]="odd">
        <Label verticalAlignment="center" [text]="item.name" class="list-group-item-text" textWrap="true"></Label>
        </StackLayout>
    </ng-template>

    <ng-template cvTemplateKey="Forward" let-item="item" let-odd="odd">
        <StackLayout [nsRouterLink]="['/item', item.id]" borderColor="red" borderWidth="2" borderRadius="5" verticalAlignment="stretch" class="list-group-item" [class.odd]="odd">
        <Label verticalAlignment="center" [text]="item.name" class="list-group-item-text" textWrap="true"></Label>
        </StackLayout>
    </ng-template>
</CollectionView>

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

Usage in Vue 3

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

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

Simple Example

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

<script setup lang="ts">
import { ObservableArray } from '@nativescript/core';
import { ref } from "nativescript-vue";

const itemList = ref(new ObservableArray([
    { name: 'TURQUOISE', color: '#1abc9c' },
    { name: 'EMERALD', color: '#2ecc71' },
    { name: 'PETER RIVER', color: '#3498db' },
    { name: 'AMETHYST', color: '#9b59b6' },
    { name: 'WET ASPHALT', color: '#34495e' }
]));
</script>

Then add the following XML to your component.

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

Usage in Vue 2

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

Simple Example

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

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.

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

Usage in Svelte

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

Simple Example

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

import { Template } from '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:

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

Usage in React

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

Simple Example

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

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) => (
    <label text={item.name} />
);

export function First() {
    return (
        <CollectionView items={items} colWidth="50%" rowHeight="100" cellFactory={cellFactory} width="100%" height="100%" />
    );
}

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

Demos

This repository includes Angular, Vue.js, and Svelte demos. In order to run these execute the following in your 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

Repo Setup

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.

Build

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

Demos

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

npm run demo.svelte.ios # Example

Contributing

Update repo

You can update the repo files quite easily

First update the submodules

npm run update

Then commit the changes Then update common files

npm run sync

Then you can run yarn|pnpm, commit changed files if any

Update readme

npm run readme

Update doc

npm run doc

Publish

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

npm run publish

modifying submodules

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

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

swipemenu

@nativescript-community/ui-collectionview-swipemenu

A NativeScript CollectionView SwipeMenu Plugin.

Installation
Configuration
API
CollectionView extensions
- Events
- Propert
- Methods
Usage
- Simple Example
Demos and Development
- Repo Setup
- Build
- Demos
Contributing
Questions

Installation

Run the following command from the root of your project:

ns plugin add @nativescript-community/ui-collectionview-swipemenu

Configuration

To install the plugin run:

import install from '@nativescript-community/ui-collectionview-swipemenu';
install();

API

CollectionView extensions

Events

Property	Description
swipeMenuOpen	Triggered when a menu is opened in the CollectionView.
swipeMenuClose	Triggered when a menu is closed in the CollectionView.

Propert

Methods

Name	Return	Description
closeCurrentMenu()	`void`	Close any opened menu in the CollectionView.

Usage

First very important note. For this plugin to work correctly, collectionview items must be an object! The plugin will add startingSide property to your items as needed to keep knowledge of which menu is opened and notify the template SwipeMenu. Might change in the future

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

Simple Example

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

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' }
];

Demos and Development

Repo Setup

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.

Build

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

Demos

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

npm run demo.svelte.ios # Example

Contributing

Update repo

You can update the repo files quite easily

First update the submodules

npm run update

Then commit the changes Then update common files

npm run sync

Then you can run yarn|pnpm, commit changed files if any

Update readme

npm run readme

Update doc

npm run doc

Publish

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

npm run publish

modifying submodules

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

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

waterfall

@nativescript-community/ui-collectionview-waterfall

A NativeScript CollectionView waterfall Plugin.

Installation
Configuration
Demos and Development
- Repo Setup
- Build
- Demos
Contributing
Questions

Installation

Run the following command from the root of your project:

ns plugin add @nativescript-community/ui-collectionview-waterfall

Configuration

To install the plugin run:

import install from '@nativescript-community/ui-collectionview-waterfall';
install();

then simply use the layoutStyle="waterfall" as a collectionview property

Demos and Development

Repo Setup

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.

Build

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

Demos

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

npm run demo.svelte.ios # Example

Contributing

Update repo

You can update the repo files quite easily

First update the submodules

npm run update

Then commit the changes Then update common files

npm run sync

Then you can run yarn|pnpm, commit changed files if any

Update readme

npm run readme

Update doc

npm run doc

Publish

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

npm run publish

modifying submodules

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

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

Demos and Development

Repo Setup

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.

Build

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

Demos

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

npm run demo.svelte.ios # Example

Contributing

Update repo

You can update the repo files quite easily

First update the submodules

npm run update

Then commit the changes Then update common files

npm run sync

Then you can run yarn|pnpm, commit changed files if any

Update readme

npm run readme

Update doc

npm run doc

Publish

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

npm run publish

modifying submodules

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

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

Documentation

@nativescript-community/ui-collectionview-alignedflowlayout

Table of Contents

Installation

Configuration

Demos and Development

Repo Setup

Build

Demos

Contributing

Update repo

Update readme

Update doc

Publish

modifying submodules

Questions

@nativescript-community/ui-collectionview

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

@nativescript-community/ui-collectionview-swipemenu

Table of Contents

Installation

Configuration

API

CollectionView extensions

Events

Propert

Methods

Usage

Simple Example

Demos and Development

Repo Setup

Build

Demos

Contributing

Update repo

Update readme

Update doc

Publish

modifying submodules

Questions

@nativescript-community/ui-collectionview-waterfall

Table of Contents

Installation

Configuration

Demos and Development

Repo Setup

Build

Demos

Contributing