Merge pull request #21 from TheOriginalJosh/page-indicators

Page indicators

Author: TheOriginalJosh

README.md

@@ -73,6 +73,8 @@ the `<Slides:SlideContainer>` element also has a property called `loop` which is
 
 the `<Slides:SlideContainer>` element also has a property called `velocityScrolling` which is a boolean value and if set to true will calculate transitions speeds based on the finger movement speed.
 
+the `<Slides:SlideContainer>` element also has a property called `pageIndicators` which will add indicator dots to the bottom of your slides.
+
 the `<Slides:SlideContainer>` element also has a property called `interval` which is a integer value and the value is in milliseconds. The suggested use case would be for a Image Carousel or something of that nature which can change the image for every fixed intervals. In unloaded function call `page.getViewById("your_id").stopSlideshow()` to unregister it (your_id is the id given to `<Slides:SlideContainer>`), it can be restarted with `startSlidShow`.
 
 #### Angular 2 compatibility

demo/app/main-page.xml

@@ -1,7 +1,7 @@
 <Page xmlns="http://schemas.nativescript.org/tns.xsd" xmlns:Slides="nativescript-slides" loaded="pageLoaded">
 
 	<GridLayout rows="* auto">
-		<Slides:SlideContainer id="slides" row="0">
+		<Slides:SlideContainer id="slides" row="0" pageIndicators="true">
 			<Slides:Slide class="slide-1">
 				<Label text="This is Panel 1"  />
 			</Slides:Slide>
@@ -19,9 +19,6 @@
 			</Slides:Slide>
 		</Slides:SlideContainer>
 
-		<StackLayout row="1">
-			<button tap="next" text="Next"/>
-			<button tap="prev" text="Prev"/>
-		</StackLayout>
+
 	</GridLayout>
 </Page>

nativescript-slides.d.ts

@@ -1,9 +1,11 @@
 import { AbsoluteLayout } from 'ui/layouts/absolute-layout';
 import { StackLayout } from 'ui/layouts/stack-layout';
+import { Label } from 'ui/label';
 export declare class Slide extends StackLayout {
 }
 export interface ISlideMap {
     panel: StackLayout;
+    index: number;
     left?: ISlideMap;
     right?: ISlideMap;
 }
@@ -20,6 +22,14 @@ export declare class SlideContainer extends AbsoluteLayout {
     private _androidTranslucentNavBar;
     private timer_reference;
     private _angular;
+    private _footer;
+    private _pageIndicators;
+    private _pageIndicatorsColor;
+    private _pageIndicatorsActiveImage;
+    private indicatorImage;
+    pageIndicators: boolean;
+    pageIndicatorsColor: string;
+    pageIndicatorsActiveImage: string;
     hasNext: boolean;
     hasPrevious: boolean;
     interval: number;
@@ -31,6 +41,7 @@ export declare class SlideContainer extends AbsoluteLayout {
     angular: boolean;
     android: any;
     ios: any;
+    currentIndex: number;
     constructor();
     private setupDefaultValues();
     constructView(constructor?: boolean): void;
@@ -45,8 +56,10 @@ export declare class SlideContainer extends AbsoluteLayout {
     private applySwipe(pageWidth);
     private showRightSlide(panelMap, offset?, endingVelocity?);
     private showLeftSlide(panelMap, offset?, endingVelocity?);
-    private buildFooter();
+    private buildFooter(pageCount?, activeIndex?);
     private setwidthPercent(view, percentage);
     private newFooterButton(name);
     private buildSlideMap(views);
+    createIndicator(): Label;
+    setActivePageIndicator(index: number): void;
 }

nativescript-slides.ts

@@ -7,7 +7,10 @@ import { Button } from 'ui/button';
 import {Label} from 'ui/label';
 import * as AnimationModule from 'ui/animation';
 import * as gestures from 'ui/gestures';
-import {AnimationCurve} from 'ui/enums';
+import {AnimationCurve, Orientation} from 'ui/enums';
+import {Color} from 'color';
+import {Image} from 'ui/image';
+import * as imageSource from 'image-source';
 
 let LayoutParams: any;
 if (app.android) {
@@ -26,6 +29,7 @@ enum direction {
 
 export interface ISlideMap {
 	panel: StackLayout;
+	index: number;
 	left?: ISlideMap;
 	right?: ISlideMap;
 }
@@ -43,11 +47,39 @@ export class SlideContainer extends AbsoluteLayout {
 	private _androidTranslucentNavBar: boolean;
 	private timer_reference: number;
 	private _angular: boolean;
+	private _footer: StackLayout;
+	private _pageIndicators: boolean;
+	private _pageIndicatorsColor: Color;
+	private _pageIndicatorsActiveImage: string;
+	private indicatorImage: Image;
+	/* page indicator stuff*/
+	get pageIndicators(): boolean {
+		return this._pageIndicators;
+	}
+	set pageIndicators(value: boolean) {
+		this._pageIndicators = value;
+	}
+
+	set pageIndicatorsColor(value: string) {
+		this._pageIndicatorsColor = new Color(value);
+	}
+	get pageIndicatorsColor() {
+		return this._pageIndicatorsColor.hex
+	}
+
+	get pageIndicatorsActiveImage(): string {
+		return this._pageIndicatorsActiveImage;
+	}
+	set pageIndicatorsActiveImage(value: string) {
+		this.indicatorImage.imageSource = imageSource.fromFile(value);
+		this._pageIndicatorsActiveImage = value;
+	}
+
+
 
 	get hasNext(): boolean {
 		return !!this.currentPanel.right;
 	}
-
 	get hasPrevious(): boolean {
 		return !!this.currentPanel.left;
 	}
@@ -110,14 +142,17 @@ export class SlideContainer extends AbsoluteLayout {
 		return;
 	}
 
+	get currentIndex(): number {
+		return this.currentPanel.index;
+	}
+
 	constructor() {
 		super();
 		this.setupDefaultValues();
 		// if being used in an ng2 app we want to prevent it from excuting the constructView
 		// until it is called manually in ngAfterViewInit.
 
 		this.constructView(true);
-
 	}
 
 	private setupDefaultValues(): void {
@@ -127,7 +162,6 @@ export class SlideContainer extends AbsoluteLayout {
 		}
 
 		this.transitioning = false;
-
 		this._pageWidth = Platform.screen.mainScreen.widthDIPs;
 
 		if (this._interval == null) {
@@ -141,6 +175,13 @@ export class SlideContainer extends AbsoluteLayout {
 			this.angular = false;
 		}
 
+		if (this._pageIndicators == null) {
+			this._pageIndicators = false;
+		} else {
+			if (this._pageIndicatorsColor == null) {
+				this._pageIndicatorsColor = new Color('#fff')
+			}
+		}
 	}
 
 	public constructView(constructor: boolean = false): void {
@@ -178,6 +219,13 @@ export class SlideContainer extends AbsoluteLayout {
 					}
 				});
 
+				if (this.pageIndicators) {
+					this._footer = this.buildFooter(slides.length, 0);
+					this.addChild(this._footer);
+					this.setActivePageIndicator(0);
+				}
+
+
 				this.currentPanel = this.buildSlideMap(slides);
 				this.currentPanel.panel.translateX = -this.pageWidth;
 				this.applySwipe(this.pageWidth);
@@ -192,6 +240,8 @@ export class SlideContainer extends AbsoluteLayout {
 						}
 					});
 					this.applySwipe(this.pageWidth);
+					let topOffset = Platform.screen.mainScreen.heightDIPs - 105;
+					AbsoluteLayout.setTop(this._footer, topOffset);
 					this.currentPanel.panel.translateX = -this.pageWidth;
 				});
 			}
@@ -264,6 +314,7 @@ export class SlideContainer extends AbsoluteLayout {
 		this.transitioning = false;
 		this.currentPanel.panel.off('pan');
 		this.currentPanel = panel;
+		this.setActivePageIndicator(this.currentPanel.index);
 		this.applySwipe(this.pageWidth);
 		this.rebindSlideShow();
 	}
@@ -428,31 +479,25 @@ export class SlideContainer extends AbsoluteLayout {
 	/**
 	 * currently deprecated.... will come back to life for navigation dots.
 	 *  */
-	private buildFooter(): AbsoluteLayout {
-		let footer = new AbsoluteLayout();
+	private buildFooter(pageCount: number = 5, activeIndex: number = 0): StackLayout {
 		let footerInnerWrap = new StackLayout();
-		let footerInnerWrapLeft = new StackLayout();
-		let footerInnerWrapMiddle = new StackLayout();
-		let footerInnerWrapRight = new StackLayout();
-		this.setwidthPercent(footer, 100);
+		const topOffset = Platform.screen.mainScreen.heightDIPs - 105;
+		footerInnerWrap.height = 20;
 
-		footerInnerWrap.orientation = 'horizontal';
 		this.setwidthPercent(footerInnerWrap, 100);
+		AbsoluteLayout.setLeft(footerInnerWrap, 0);
+		AbsoluteLayout.setTop(footerInnerWrap, topOffset);
 
-		footer.addChild(footerInnerWrap);
-
-		this.setwidthPercent(footerInnerWrapRight, 30);
-		this.setwidthPercent(footerInnerWrapLeft, 30);
-		this.setwidthPercent(footerInnerWrapMiddle, 40);
-
-		footerInnerWrapLeft.addChild(this.newFooterButton('Previous'));
-		footerInnerWrapRight.addChild(this.newFooterButton('Next'));
-
-		footerInnerWrap.addChild(footerInnerWrapLeft);
-		footerInnerWrap.addChild(footerInnerWrapMiddle);
-		footerInnerWrap.addChild(footerInnerWrapRight);
+		footerInnerWrap.orientation = 'horizontal';
+		footerInnerWrap.verticalAlignment = 'top';
+		footerInnerWrap.horizontalAlignment = 'center';
 
-		return footer;
+		let i = 0;
+		while (i < pageCount) {
+			footerInnerWrap.addChild(this.createIndicator());
+			i++;
+		}
+		return footerInnerWrap;
 	}
 
 	private setwidthPercent(view: View, percentage: number) {
@@ -469,9 +514,10 @@ export class SlideContainer extends AbsoluteLayout {
 
 	private buildSlideMap(views: StackLayout[]) {
 		let slideMap: ISlideMap[] = [];
-		views.forEach((view: StackLayout) => {
+		views.forEach((view: StackLayout, index: number) => {
 			slideMap.push({
-				panel: view
+				panel: view,
+				index: index,
 			});
 		});
 		slideMap.forEach((mapping: ISlideMap, index: number) => {
@@ -488,4 +534,36 @@ export class SlideContainer extends AbsoluteLayout {
 		this.startSlideshow();
 		return slideMap[0];
 	}
+
+	createIndicator(): Label {
+		let indicator = new Label();
+		indicator.backgroundColor = new Color('#fff');
+		indicator.width = 10;
+		indicator.height = 10;
+		indicator.marginLeft = 2.5;
+		indicator.marginRight = 2.5;
+		indicator.borderRadius = 5;
+		return indicator;
+	}
+
+	setActivePageIndicator(index: number) {
+
+		this._footer.eachLayoutChild((view: View) => {
+			if (view instanceof Label) {
+				view.opacity = 0.4;
+				if (this._pageIndicatorsActiveImage != null) {
+					view.backgroundColor = new Color('#fff');
+					view.className = 'slide-indicator-inactive';
+					view.backgroundImage = null;
+				}
+			}
+		});
+		let activeIndicator = this._footer.getChildAt(index);
+		activeIndicator.className = 'slide-indicator-active';
+		activeIndicator.opacity = 0.9;
+		if (this._pageIndicatorsActiveImage != null) {
+			activeIndicator.backgroundColor = null;
+			activeIndicator.backgroundImage = this.pageIndicatorsActiveImage;
+		}
+	}
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nativescript-slides",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "NativeScript Slides plugin.",
   "main": "nativescript-slides.js",
   "nativescript": {