Thanks to all of you who have downloaded this plugin! Please consider leaving a rating and review, it would be really helpful to get your feedbacks. Thanks.
Plugin by icliclabs.com
This plugin is compatible with Ionic v2.x and v3.x!
Description
Onboard your users easily with Ionic Walkthrough and improve your first time user experience. Thanks to this component, you can easily embed screenshots of your application to explain the key features of your app. You can customize the phone image (iPhone or Android). You can also pick on of the following colors: silver, spacegrey, gold, white or black. This plugin works on iOS, Android and Windows Phone.
Test Before You Buy
You can test the app using Ionic View and enter the app id 2f2ea620.
Features
- Works with iOS, Android and Windows Phone.
- Easy to include in your existing app.
- 5 different device images: iPhone space grey, iPhone silver, iPhone gold, Android black, Android white.
- Easily custom the background color, the text color and the buttons.
- It comes with a full and detailed example.
- This component has well structured html, css and js files and is heavily commented, so that it is easy to edit, add your style, etc.
Installation
- Copy the
app/components/ionic-walkthrough.ts
file into your app directory
- Import
IonWalkthrough
component and add it to the declarations
list in the app/app.module.ts
file
- Copy the
app/assets/ionic-walkthrough/
directory into your app/assets/
directory
That's all!
Usage
- in your view, add
<ion-walkthrough [options]="slide"></ion-walkthrough>
in your ion-slide
, the parameter slide
is an IonWalkthroughOptions
where you set the title, the description, the image and other options.
That's all. Here is an example of the view, very simple. Just include the ion-walkthrough component:
<ion-content>
<ion-slides #mySlider [options]="mySlideOptions">
<ion-slide *ngFor="let slide of slides">
<!-- insert ion-walkthrough component here -->
<ion-walkthrough [options]="slide"></ion-walkthrough>
<!-- -->
</ion-slide>
</ion-slides>
</ion-content>
Here is a full example of your page component with 1 slide:
import { Component, ViewChild } from '@angular/core';
import { NavController, Slides } from 'ionic-angular';
import { IonWalkthroughOptions } from '../../components/ion-walkthrough';
@Component({
selector: 'page-home',
templateUrl: 'home.html'
})
export class HomePage {
// reference to the ionic slider (to be able to go to next slide)
@ViewChild('mySlider') slider: Slides;
// list of slides
slides: Array<IonWalkthroughOptions>;
// the ionic slider options if you want to customize it
mySlideOptions: any;
constructor(public navCtrl: NavController) {
// customize your ionic slider if needed
// https://ionicframework.com/docs/v2/api/components/slides/Slides/
this.mySlideOptions = {};
// keeping a reference so we can access `this.slider` from our onClick function
let _this = this;
// add your slides here. Note that all attributes are not mandatory, only title, description and image are.
this.slides = [
{
title: 'Welcome to Ionic Walkthrough!',
description: '<b>Ionic Walkthrough</b> is an Ionic component to quickly onboard new users. Simply specify a title, a text and an image for each slide.',
image: './assets/screenshots/ios_1.png',
styles: {
background: 'linear-gradient(to right, #347eff 0%, #1ea3ff 100%)',
titleColor: '#fff',
descriptionColor: '#fff'
},
layout: {
position: 'bottom', //top, bottom (default)
deviceType: 'iphone', //iphone, android (default)
deviceColor: 'silver' //iphone: silver, spacegrey, gold android: white, black (default)
},
buttons: {
left: {
text: 'SKIP',
textColor: '#fff',
onClick: function() {
alert('go to sign up page')
}
},
right: {
text: 'NEXT',
textColor: '#fff',
onClick: function() {
_this.slider.slideNext(); //using the ionic slider to go to the next slide
}
}
}
}
];
}
}
Other Popular Plugins:
- Ionic Categories: Ionic v2.x/v3.x
- Ionic Passcode Square: Ionic v2.x/v3.x
- Ionic Passcode Flat: Ionic v2.x/v3.x
- Ionic Passcode Round: Ionic v2.x/v3.x
- Ionic Shrinking Header: Ionic v2.x/v3.x
- Ionic Material Sidemenu: Ionic v2.x/v3.x
- Ionic Walkthrough: Ionic v2.x/v3.x
- Ionic Contacts Inviter: Ionic v2.x/v3.x
- Ionic Cover Header: Ionic v1.x - Ionic v2.x/v3.x
- Ionic Profile Header: Ionic v2.x/v3.x
- Ionic Numeric Keyboard: Ionic v1.x - Ionic v2.x/v3.x
- Ionic Phone Number Validator: Ionic v1.x
- Ionic Cover Item: Ionic v1.x
- Ionic Timer: Ionic v1.x
Need Custom Work?
If you need help with your Ionic apps, if you need a specific plugin or integration. Let's get in touch. I'll be glad to develop or advise you for your app! Email me at icl1clabs@gmail.com.