https://github.com/xeeo/ng-addthis
AddThis Integration with Angular — Edit
https://github.com/xeeo/ng-addthis
Last synced: about 1 year ago
JSON representation
AddThis Integration with Angular — Edit
- Host: GitHub
- URL: https://github.com/xeeo/ng-addthis
- Owner: xeeo
- Created: 2015-07-22T09:44:03.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-07-27T13:53:53.000Z (almost 11 years ago)
- Last Synced: 2025-02-14T15:04:19.533Z (over 1 year ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Angular AddThis Module
A simple wrapper to pull in the AddThis snippet with an AngularJS-based application. This structure is based on [ng-optimizely](https://github.com/jacopotarantino/ng-optimizely)
This module provides only a simple API to download the AddThis snippet onto the page. The `loadProject` method(usage described below) returns a promise so you can delay execution until after the snippet has loaded.
## Install
```bash
$ bower install --save ng-addthis
```
Then require ng-addthis in your application:
```javascript
var app = angular.module('app', ['ng-addthis']);
```
## Run
In your app's run block execute the `initAddThis` method:
```javascript
angular.module('app')
.run(['addThisService', function(addThisService) {
addThisService.initAddThis('12345678');
}]);
```
Another way to load the library and avoid a FOUC is to use a router like [ui-router](https://github.com/angular-ui/ui-router) that allows you to defer pageload until after all of a given route's dependencies have been loaded. The `loadProject` method returns a promise so you can use it with any give plugin or framework but ui-router is a really good choice for most projects.
```javascript
app.config(function($stateProvider, addThisService) {
$stateProvider.state('app.dashboard', {
// ... other stuff ...
resolve: {
addThisService: function(addThisService) {
addThisService.loadProject('12345678');
}
}
});
});
```
An important aspect is that you might not want to have the AddThis widget on all pages. So that there is a function you can use to hide the script. This can be used on state change for example.
```javascript
angular.module('app')
.run(['$rootScope', 'addThisService', function($rootScope, addThisService) {
$rootScope.$on('$stateChangeStart',
function(event, toState, toParams, fromState, fromParams) {
if (toState.name === 'your--state') {
addThisService.loadProject('12345678');
} else {
addThisService.hideLayers(0);
}
});
}]);
```
## Test
I can say TODO ... but I won't do them .... This thing is already in production so enjoy :D
## License
The MIT License (MIT)
Copyright (c) 2014 Geana Raul
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.