Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update PickerConfiguration #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update PickerConfiguration #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 18 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,25 +66,24 @@ export default App;

## Picker Props

| params | value | default value | description |
|------------------|----------|------------------|-------------------------------|
| callbackFunction |function | REQUIRED |Callback function that will be called on picker action |
| clientId | string | REQUIRED | Google client id |
| developerKey | string | REQUIRED | Google developer key |
| disableDefaultView | boolean | false | disables default view |
| viewId | string | DOCS | ViewIdOptions |
| viewMimeTypes | string | optional |Comma separated mimetypes. Use this in place of viewId if you need to filter multiple type of files. list: https://developers.google.com/drive/api/v3/mime-types.|
|setIncludeFolders| boolean | false |Show folders in the view items.|
|setSelectFolderEnabled|boolean| false |Allows the user to select a folder in Google Drive.|
| token | string | optional | access_token to skip auth part|
| multiselect | boolean | false | Enable picker multiselect |
| supportDrives | boolean | false | Support shared drives |
| showUploadView | boolean | false | Enable upload view |
| showUploadFolders| boolean | false |Enable folder selection(upload)|
| setParentFolder | string | disabled | Drive folder id to upload |
| customViews |ViewClass[]| optional | Array of custom views you want to add to the picker|
| customScopes |string[]| ['https://www.googleapis.com/auth/drive.readonly'] | Array of custom scopes you want to add to the picker|
| locale |string | en | List of supported locales https://developers.google.com/picker/docs#i18n|
| params | value | default value | description |
|------------------------|-------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| callbackFunction | function | REQUIRED | Callback function that will be called on picker action |
| clientId | string | REQUIRED | Google client id |
| developerKey | string | REQUIRED | Google developer key |
| disableDefaultView | boolean | false | disables default view |
| viewId | string | DOCS | ViewIdOptions |
| viewMimeTypes | string | optional | Comma separated mimetypes. Use this in place of viewId if you need to filter multiple type of files. list: https://developers.google.com/drive/api/v3/mime-types. |
| setIncludeFolders | boolean | false | Show folders in the view items. |
| setSelectFolderEnabled | boolean | false | Allows the user to select a folder in Google Drive. |
| token | string | optional | access_token to skip auth part |
| enabledFeatures | string[] | optional | Enable [features](https://developers.google.com/drive/picker/reference#feature) of various views. |
| showUploadView | boolean | false | Enable upload view |
| showUploadFolders | boolean | false | Enable folder selection(upload) |
| setParentFolder | string | disabled | Drive folder id to upload |
| customViews | ViewClass[] | optional | Array of custom views you want to add to the picker |
| customScopes | string[] | ['https://www.googleapis.com/auth/drive.readonly'] | Array of custom scopes you want to add to the picker |
| locale | string | en | List of supported locales https://developers.google.com/picker/docs#i18n |


## viewId options
Expand Down
6 changes: 2 additions & 4 deletions demo/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ function App() {
// token,
showUploadView: true,
showUploadFolders: true,
supportDrives: true,
multiselect: true,
enabledFeatures: ['SUPPORT_DRIVES', 'MULTISELECT'],
customScopes: ['https://www.googleapis.com/auth/gmail.readonly'],
callbackFunction: (data) => {
if (data.action === 'cancel') {
Expand All @@ -49,8 +48,7 @@ function App() {
// token: token
showUploadView: true,
showUploadFolders: true,
supportDrives: true,
multiselect: true,
enabledFeatures: ['SIMPLE_UPLOAD', 'MINE_ONLY'],
callbackFunction: (data) => {
console.log(data)
},
Expand Down
33 changes: 25 additions & 8 deletions src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,9 @@ export default function useDrivePicker(): [
const createPicker = ({
token,
appId = '',
supportDrives = false,
developerKey,
viewId = 'DOCS',
disabled,
multiselect,
showUploadView = false,
showUploadFolders,
setParentFolder = '',
Expand All @@ -118,6 +116,7 @@ export default function useDrivePicker(): [
setSelectFolderEnabled,
disableDefaultView = false,
callbackFunction,
enabledFeatures,
}: PickerConfiguration) => {
if (disabled) return false

Expand Down Expand Up @@ -146,14 +145,32 @@ export default function useDrivePicker(): [
customViews.map((view) => picker.addView(view))
}

if (multiselect) {
picker.enableFeature(google.picker.Feature.MULTISELECT_ENABLED)
}

if (showUploadView) picker.addView(uploadView)

if (supportDrives) {
picker.enableFeature(google.picker.Feature.SUPPORT_DRIVES)
if (enabledFeatures) {
enabledFeatures.forEach((feature) => {
let featureType
switch (feature) {
case 'MINE_ONLY':
featureType = google.picker.Feature.MINE_ONLY
break
case 'MULTISELECT':
featureType = google.picker.Feature.MULTISELECT_ENABLED
break
case 'HIDE_NAV':
featureType = google.picker.Feature.NAV_HIDDEN
break
case 'SIMPLE_UPLOAD':
featureType = google.picker.Feature.SIMPLE_UPLOAD_ENABLED
break
case 'SUPPORT_DRIVES':
featureType = google.picker.Feature.SUPPORT_DRIVES
break
default:
featureType = undefined
}
if (featureType) picker.enableFeature(featureType)
})
}

picker.build().setVisible(true)
Expand Down
24 changes: 15 additions & 9 deletions src/typeDefs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ export type PickerCallback = {
docs: CallbackDoc[]
}

export type authResult = {
access_token: string;
token_type: string;
expires_in: number;
scope: string;
authuser: string;
prompt: string;
export type authResult = {
access_token: string
token_type: string
expires_in: number
scope: string
authuser: string
prompt: string
}

type ViewIdOptions =
Expand All @@ -45,6 +45,13 @@ type ViewIdOptions =
| 'SPREADSHEETS'
| 'PRESENTATIONS'

export type PickerFeatureOption =
| 'MINE_ONLY'
| 'MULTISELECT'
| 'HIDE_NAV'
| 'SIMPLE_UPLOAD'
| 'SUPPORT_DRIVES'

export type PickerConfiguration = {
clientId: string
developerKey: string
Expand All @@ -54,10 +61,8 @@ export type PickerConfiguration = {
setSelectFolderEnabled?: boolean
disableDefaultView?: boolean
token?: string
multiselect?: boolean
disabled?: boolean
appId?: string
supportDrives?: boolean
showUploadView?: boolean
showUploadFolders?: boolean
setParentFolder?: string
Expand All @@ -66,6 +71,7 @@ export type PickerConfiguration = {
locale?: string
customScopes?: string[]
callbackFunction: (data: PickerCallback) => any
enabledFeatures?: PickerFeatureOption[]
}

export const defaultConfiguration: PickerConfiguration = {
Expand Down