Skip to content

frandiox/angular-google-picker

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

angular-google-picker

Angular directive that interact with the Google API Picker :

Requirements: AngularJS 1.2+

File Size: 1.67Kb minified

Installation

  1. Using Bower (recommended)
bower install https://github.com/frankdiox/angular-google-picker.git --save
  1. Using NPM
npm install https://github.com/frankdiox/angular-google-picker.git --save
  1. Manually

Download https://github.com/frankdiox/angular-google-picker/archive/0.2.0.zip

Usage

  1. Include Google client and api script in your layout
<script src="http://apis.google.com/js/client.js"></script>
<script src="http://apis.google.com/js/api.js"></script>
  1. Include the Google Picker as a dependency for your app
angular.module('myApp', ['lk-google-picker'])
  1. Configure the plugin (see below configuration section)

  2. Create a scope to handle files that will be selected

angular.module('myApp', ['lk-google-picker'])

.controller('ExamplaCtrl', ['$scope', function($scope) {
  $scope.myCallback = function(data) {
    if (data.action === 'picked') {
      console.log('Files: ', data.docs);
    } else if (data.action === 'cancel') {
      console.log('Request canceled');
    }
  };
}]);
  1. Add the directive to your HTML element
<a href="javascript:;" lk-google-picker picker-callback="myCallback">Open my Google Drive</a>
  1. That's it, you're done!

You'll notice here the usage of picker-callback. You need to pass here a callback that will handle the data received. The callback receives a "data" object that contains an "action" member with the values "picked" or "canceled" depending on the user action. The "docs" member will contain an array with the selected files. Every file is a json object that looks like :

[
  {
    "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/. To do so, you'll need to configure the service.

Using configure(options)

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).

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 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 :

angular.module('myApp', ['lk-google-picker'])

.config(['lkGoogleSettingsProvider', function(lkGoogleSettingsProvider) {
  lkGoogleSettingsProvider.views([
    'DocsUploadView()',
    'DocsView()'
  ]);
}])

NOTE : Views classes have some usefull methods such as setIncludeFolders or setStarred (or any other methods available). In order to use them, just chain them to the class :

angular.module('myApp', ['lk-google-picker'])

.config(['lkGoogleSettingsProvider', function(lkGoogleSettingsProvider) {
  lkGoogleSettingsProvider.setViews([
    'DocsUploadView().setIncludeFolders(true)',
    'DocsView().setStarred(true)'
  ]);
}])

Default : DocsUploadView and DocsView are use as default.

Please refer to https://developers.google.com/picker/docs/reference for more informations.

Example

The demo version available at http://frankdiox.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 :

$ 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.

Demo

A demo version is available at http://frankdiox.github.io/angular-google-picker/.

License

Licensed under the MIT license

About

An Angular directive that interact with Google Picker API

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 67.3%
  • HTML 21.1%
  • CSS 11.6%