Skip to content

Latest commit

 

History

History
131 lines (83 loc) · 4.36 KB

README.md

File metadata and controls

131 lines (83 loc) · 4.36 KB
Raw

bitHound Score

##Introduction:

This is an ionic-toast bower component which can be used with any Ionic framework's application.

View Demo

##Prerequisites.

  1. node.js, bower and gulp.

##How to use:

1) In your project repository install the ionic-toast using bower

bower install ionic-toast --save

This will install the latest version released. If you wish to install a specific version please use bower install ionic-toast#<version number>

2) Give the path of ionic-toast.bundle.min.js in your index.html file.

<!-- path to ionic / angularjs files-->
<script src="lib/ionic-toast/dist/ionic-toast.bundle.min.js"></script>

3) In your application module inject the dependency ionic-toast, in order to work with the ionic toast.

angular.module('mainModuleName', ['ionic', 'ionic-toast']){
 //
}

4) Inject 'ionicToast' in your controller.

.controller('HomeCtrl', ['$scope', 'ionicToast', function($scope, ionicToast) {
  //code here
}])

5) In your template, you can use like below

<button class="button button-block" ng-click="showToast()">Show Toast at top with close</button>

6) In your controller you have to define a function like below to show the toast

$scope.showToast = function(){
<!-- ionicToast.show(message, position, stick, time); -->
  ionicToast.show('This is a toast at the top.', 'top', true, 2500);
};

The arguments are as follows. The order of arguments should not be changed.

a) message is the first argument, which takes any string message.

b) position(Optional) is the second argument, which takes on of the three values(top, middle, bottom). default position is top.

c) stick(Optional) is the third argument, which takes either true or false. Default value is false.

  • If the value is true, the toast will not close automatically. It will be closed once you click on the close button.
  • If the value is false, the toast will close automatically, after the given time.

d) timeout(Optional) is the fourth argument, which takes time in milliseconds. If the value is greater than 10000, then it will be considered as 10000(10 seconds) only. The default value is 4000 milli seconds.

7) In your controller you have to define a function like below to hide the toast

$scope.hideToast = function(){
  ionicToast.hide();
};

##Screen Shots:

Once you are successfully done with the above steps, you should be able to see the below screen shots. I have used three buttons here.

The first screen shot shows only the buttons before clicking on them. Once you click on the button you should see the remaining screen shots.

ionic-toast buttons ionic-toast top ionic-toast middle ionic-toast bottom

##Versions:

1) v0.1.0

The whole ionic-toast component functionality has been implemented, and it can be installed with the command bower install ionic-toast --save

2) v0.1.1

Bug Fix

3) v0.2.0

Lint issues fixed, npm packages updated, main files added in the package.json, changes in the gulp tasks.

4) v0.3.0

Code modularity implemented, npm packages updated.

JS and CSS file is combined into one ionic-toast.bundle.min.js file in the dist folder.

5) v0.4.0

Bug fix.

6) v0.4.1

Issue#21

##License: MIT

##Contact: gmail : rajeshwar.patlolla@gmail.com

github : https://github.com/rajeshwarpatlolla

twitter : https://twitter.com/rajeshwar_9032

facebook : https://www.facebook.com/rajeshwarpatlolla

paypal : rajeshwar.patlolla@gmail.com

Rate / Comment : http://market.ionic.io/plugins/ionictoast