Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajeshwarpatlolla/ionic-toast
'ionic-toast' bower component for ionic framework applications
https://github.com/rajeshwarpatlolla/ionic-toast
angularjs hybridapp ionic package toast
Last synced: 7 days ago
JSON representation
'ionic-toast' bower component for ionic framework applications
- Host: GitHub
- URL: https://github.com/rajeshwarpatlolla/ionic-toast
- Owner: rajeshwarpatlolla
- License: mit
- Created: 2015-06-24T07:09:50.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T16:28:51.000Z (about 5 years ago)
- Last Synced: 2025-01-08T03:26:40.159Z (14 days ago)
- Topics: angularjs, hybridapp, ionic, package, toast
- Language: JavaScript
- Homepage:
- Size: 48.8 KB
- Stars: 157
- Watchers: 12
- Forks: 58
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://www.bithound.io/github/rajeshwarpatlolla/ionic-toast)
## Introduction:
This is an `ionic-toast` bower component which can be used with any Ionic framework's application.
[View Demo](http://rajeshwarpatlolla.github.io/ionic-toast-demo/demo/ "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#`
**2)** Give the path of `ionic-toast.bundle.min.js` in your `index.html` file.
````html
````
**3)** In your application module inject the dependency `ionic-toast`, in order to work with the ionic toast.
````javascript
angular.module('mainModuleName', ['ionic', 'ionic-toast']){
//
}
````
**4)** Inject 'ionicToast' in your controller.
````javascript
.controller('HomeCtrl', ['$scope', 'ionicToast', function($scope, ionicToast) {
//code here
}])
````
**5)** In your template, you can use like below
````html
Show Toast at top with close
````
**6)** In your controller you have to define a function like below to show the toast
````javascript
$scope.showToast = function(){
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 5000, then it will be considered as 5000(5 seconds) only. The default value is 4000 milli seconds.
e) `background`(Optional) is the fifth argument, which takes the background color in hexadecimal, rgb() or rgba(). If the value is null the background color is `rgba(0, 0, 0, 0.75)`.
**7)** In your controller you have to define a function like below to hide the toast
````javascript
$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.
## 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](https://github.com/rajeshwarpatlolla/ionic-toast/issues/21)
## License:
[MIT](https://github.com/rajeshwarpatlolla/ionic-toast/blob/master/LICENSE.md "MIT")
## Contact:
gmail : [email protected]
github : https://github.com/rajeshwarpatlolla
twitter : https://twitter.com/rajeshwar_9032
facebook : https://www.facebook.com/rajeshwarpatlolla
paypal : [email protected]
Rate / Comment : http://market.ionic.io/plugins/ionictoast