A NativeScript Pager / Carousel component that allows the user to swipe left and right through pages of data.
iOS Demo | Android Demo |
Run the following command from the root of your project:
ns plugin add @nativescript-community/ui-pager
Property | Type |
---|---|
items | array or ItemsSource |
selectedIndex | number |
canGoRight | boolean |
canGoLeft | boolean |
spacing | PercentLengthType |
peaking | PercentLengthType |
perPage | number |
indicator | string ('disable', 'none', 'worm', 'fill', 'swap', 'thin_worm', 'flat') |
circularMode | boolean |
autoPlayDelay | number |
autoPlay | boolean |
orientation | string ('horizontal' or 'vertical') |
autoPlay | boolean |
disableSwipe | boolean |
showIndicator | boolean |
transformers | string |
Pager for NativeScript supports the core ObservableArray module part of the core NativeScript modules collection. Using an ObservableArray instance as a source for Pager will ensure that changes in the source collection will be automatically taken care of by the control.
Import the module into your project.
import { PagerModule } from "@nativescript-community/ui-pager/angular";
@NgModule({
imports: [
PagerModule,
],
})
Import the module into your project.
import { Pager } from '@nativescript-community/ui-pager/react';
Import the module into your project.
import { registerNativeViewElement } from 'svelte-native/dom';
import PagerElement from '@nativescript-community/ui-pager/svelte';
import { PagerItem } from '@nativescript-community/ui-pager';
PagerElement.register();
registerNativeViewElement('pageritem', () => PagerItem);
Import the module into your project.
import Vue from 'nativescript-vue';
import Pager from '@nativescript-community/ui-pager/vue';
Vue.use(Pager);
You can define custom transformer for iOS/Android
You can follow the Scale
example for iOS and Android to create your custom transformer.
Then you can register your transformer on app start with (this example registered the included but not registered Scale transformer):
import { Pager } from '@nativescript-community/ui-pager';
import transformer from '@nativescript-community/ui-pager/transformers/Scale';
Pager.registerTransformer('scale', transformer)
Then you can use that transformer with the transformers
property of Pager
A NativeScript Indicator for Pager / Carousel /CollectionView
iOS Demo | Android Demo |
Run the following command from the root of your project:
ns plugin add @nativescript-community/ui-pager-indicator
Property | Type |
---|---|
color | Color or string |
selectedColor | Color or string |
PagerIndicator add page control for Pager or other Paging Views.
If you are planning to use an indicator, add the following to your module:
import { registerElement } from "@nativescript/angular";
import { PagerIndicator } from "@nativescript-community/ui-pager-indicator";
registerElement("PagerIndicator", () => PagerIndicator)
Then in your template:
<Pager id="pager" [items]="items"
...
</Pager>
<PagerIndicator pagerViewId="pager" />
Import the module into your project.
import Vue from 'nativescript-vue';
Vue.registerElement('PagerIndicator', () => require('@nativescript-community/ui-pager-indicator').PagerIndicator);
then in your template:
<Pager id="pager" :items="items"
...
</Pager>
<PagerIndicator pagerViewId="pager"/>
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.
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
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
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
npm run readme
npm run doc
The publishing is completely handled by lerna
(you can add -- --bump major
to force a major release)
Simply run
npm run publish
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/
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.