Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/softmonkeyjapan/angular-google-picker
An Angular directive that interact with Google Picker API
https://github.com/softmonkeyjapan/angular-google-picker
angularjs google-picker gulpjs javascript
Last synced: about 1 month ago
JSON representation
An Angular directive that interact with Google Picker API
- Host: GitHub
- URL: https://github.com/softmonkeyjapan/angular-google-picker
- Owner: softmonkeyjapan
- Created: 2014-08-29T05:01:48.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-12-18T09:50:13.000Z (almost 7 years ago)
- Last Synced: 2024-09-28T06:41:58.029Z (about 2 months ago)
- Topics: angularjs, google-picker, gulpjs, javascript
- Language: JavaScript
- Homepage: http://softmonkeyjapan.github.io/angular-google-picker/
- Size: 164 KB
- Stars: 78
- Watchers: 5
- Forks: 29
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
angular-google-picker
=====================
[](http://badge.fury.io/js/angular-google-picker)
[](http://badge.fury.io/bo/angular-google-picker)
[](https://coveralls.io/github/softmonkeyjapan/angular-google-picker?branch=master)
[](https://travis-ci.org/softmonkeyjapan/angular-google-picker)
[](http://commitizen.github.io/cz-cli/)
Angular directive that interact with the Google Picker API :
* [Google Picker API Overview](https://developers.google.com/picker/)
* [Google Picker API Docs](https://developers.google.com/picker/docs/)
**Requirements:** AngularJS 1.2+
**File Size:** 2.1Kb minified
## Installation
1. Using Bower (recommended)
```Bash
bower install angular-google-picker --save
```
2. Using NPM
```bash
npm install angular-google-picker --save
```
3. Manually
Download [https://github.com/softmonkeyjapan/angular-google-picker/archive/0.2.2.zip](https://github.com/softmonkeyjapan/angular-google-picker/archive/0.2.2.zip)
## Usage
1. Include Google client and api script in your layout
```html
```
2. Include the Google Picker as a dependency for your app
```js
angular.module('myApp', ['lk-google-picker'])
```
3. Configure the plugin (see below **configuration** section)
4. Create a scope to handle files that will be selected
```js
angular.module('myApp', ['lk-google-picker'])
.controller('ExampleCtrl', ['$scope', function ($scope) {
$scope.files = [];
$scope.onLoaded = function () {
console.log('Google Picker loaded!');
}
$scope.onPicked = function (docs) {
angular.forEach(docs, function (file, index) {
$scope.files.push(file);
});
}
$scope.onCancel = function () {
console.log('Google picker close/cancel!');
}
}]);
```
5. Add the directive to your HTML element
```html
Open my Google Drive
```
6. That's it, you're done!
Every file is a json object that looks like :
```json
[
{
"id": "0B50DHrsuMky6UFlSQloxYGBxT2M",
"serviceId": "docs",
"mimeType": "image/jpeg",
"name": "DSC01845.JPG",
"type": "photo",
"lastEditedUtc": 1409023514905,
"iconUrl": "https://ssl.gstatic.com/docs/doclist/images/icon_11_image_list.png",
"description": "",
"url": "https://docs.google.com/file/d/0B50DHrsuMky6UFlSQloxYGBxT2M/edit?usp=drive_web",
"sizeBytes": 1570863,
"parentId": "0B50DHrsuMkx6cWhrSXpTR1cyYW8"
},
{
...
}
]
```
## Configuration
In order to work, Google Picker needs to connect to the Google API using an application credentials (Api Key and client ID). For more information on how to create an application/project, please refer to [https://developers.google.com/drive/web/](https://developers.google.com/drive/web/). To do so, you'll need to configure the service.
### Using configure(options)
```js
angular.module('myApp', ['lk-google-picker'])
.config(['lkGoogleSettingsProvider', function (lkGoogleSettingsProvider) {
lkGoogleSettingsProvider.configure({
apiKey : 'YOUR_API_KEY',
clientId : 'YOUR_CLIENT_ID',
scopes : ['https://www.googleapis.com/auth/drive', 'another_scope', 'and_another'],
locale : 'ja',
features : ['..', '..'],
views : ['..', '..']
});
}])
```
## Features
The Picker use the concept of views and features that allow you to customize it. The service provider allow you to enable some features to the Picker the same way you define your API Key or client ID (using either configure or setters).
```js
angular.module('myApp', ['lk-google-picker'])
.config(['lkGoogleSettingsProvider', function (lkGoogleSettingsProvider) {
lkGoogleSettingsProvider.features(['MULTISELECT_ENABLED', 'ANOTHER_ONE']);
}])
```
**Default** : `MULTISELECT_ENABLED` feature is use as default.
Please refer to [https://developers.google.com/picker/docs/reference](https://developers.google.com/picker/docs/reference) for more informations.
### Views
Views are objects that needs to be instanciate using the namespace `google.picker.*`. That namespace is already defined in the core of the directive. In order to add views to your picker, all you need to do is to define the class that needs to be used :
```js
angular.module('myApp', ['lk-google-picker'])
.config(['lkGoogleSettingsProvider', function (lkGoogleSettingsProvider) {
lkGoogleSettingsProvider.views([
'DocsUploadView()',
'DocsView()'
]);
}])
```
**NOTE** : Views classes have some useful methods such as `setIncludeFolders` or `setStarred` (or any other methods available). In order to use them, just chain them to the class :
```js
angular.module('myApp', ['lk-google-picker'])
.config(['lkGoogleSettingsProvider', function (lkGoogleSettingsProvider) {
lkGoogleSettingsProvider.views([
'DocsUploadView().setIncludeFolders(true)',
'DocsView().setStarred(true)',
'DocsView(google.picker.ViewId.FOLDERS).setSelectFolderEnabled(true)'
]);
}])
```
**Default** : `DocsUploadView` and `DocsView` are use as default.
Please refer to [https://developers.google.com/picker/docs/reference](https://developers.google.com/picker/docs/reference) for more informations.
## Callbacks
The directive provide you 3 callbacks that you can use in order to work with the Picker.
### `onLoaded`
This callback is triggered after the picker has been initialized and shown on the page.
```js
angular.module('myApp', ['lk-google-picker'])
.controller('ExampleCtrl', ['$scope', function ($scope) {
$scope.onLoaded = function () {
console.log('Google Picker loaded!');
}
}]);
```
```html
Open my Google Drive
```
### `onPicked`
This callback is triggered after you select files and click on the `select` button from the Picker.
```js
angular.module('myApp', ['lk-google-picker'])
.controller('ExampleCtrl', ['$scope', function ($scope) {
$scope.onPicked = function (docs) {
// docs contains the list of google documents object as shown above.
}
}]);
```
```html
Open my Google Drive
```
### `onCancel`
This callback is triggered after the picker has been closed by clicking on the cancel button from the picker.
```js
angular.module('myApp', ['lk-google-picker'])
.controller('ExampleCtrl', ['$scope', function ($scope) {
$scope.onCancel = function () {
console.log('Google picker close/cancel!');
}
}]);
```
```html
Open my Google Drive
```
## Demo
The demo version available at [http://softmonkeyjapan.github.io/angular-google-picker/](http://softmonkeyjapan.github.io/angular-google-picker/) can be found in the `example` folder.
You will need a server in order to try it on your local machine. Since the Google Picker demo application is setup to allow origin from localhost:8000, I encourage you to use the python `SimpleHTTPServer` :
```shell
$ cd path/to/the/example/directory
$ python -m SimpleHTTPServer
Serving HTTP on 0.0.0.0 port 8000 ...
```
You should now be able to browse to `localhost:8000` and see it in action from your localhost.
## License
Licensed under the MIT license