Skip to content

GLObus303/react-google-picker-hook

Repository files navigation

React Google Drive picker hook

styled with prettier npm latest version

Google Drive API hook for React compatible with the newest Google auth API

Installation

module formats: cjs, and esm

General

  1. Add the react-google-picker-hook package
# yarn
yarn add react-google-picker-hook

## optional
yarn add --dev @types/google.picker
# npm
npm install react-google-picker-hook --save

## optional
npm install @types/google.picker --save-dev
  1. Use the package
import { useGooglePicker } from 'react-google-picker-hook';

const [openPicker] = useGooglePicker(
  (data: GoogleDrivePickerData, token: string) => {
    console.log({ data, token });

    if (data?.action === GOOGLE_ACTION.PICKED) {
      // Handle file pick
    }
  },
  {
    googleAppId: 'googleAppId',
    googleAuthClientId: 'googleAuthClientId',
    googleAppKey: 'googleAppKey',
  },
);

// ...

return <button onClick={openPicker}>Upload!</button>;

Handling errors (optional)

There are two separate error callback which can be used for error detection.

const [openPicker] = useGooglePicker(
  // ... base callback
  {
    onAuthFailed: (response: TokenResponse) => {
      console.log(response.error_description || response.details);

      // handle auth error
    },
    tokenClientConfig: {
      error_callback: ({ message, stack, type }: ErrorCallback) => {
        console.log({ message, stack, type });

        // handle client error
      },
    },
  },
);

Extending the default config (optional)

Two custom configs objects

  • tokenClientConfig is spread to Google's initTokenClient
  • customPickerConfig is used to override the minimal default config used for picker
const [openPicker] = useGooglePicker(
  // ... base callback
  {
    customPickerConfig: {
      // custom picker config
    },
    tokenClientConfig: {
      /* custom config for initTokenClient */
    },
  },
);

Two config callback functions

  • appendCustomPickerConfig
  • appendCustomViewConfig

Both used to extend the builder pattern of DocsView and PickerBuilder

const [openPicker] = useGooglePicker(
  // ... base callback
  {
    appendCustomViewConfig: (view) => {
      // extend by calling any of the inner setters
      return view;
    },
    appendCustomPickerConfig: (picker) => picker.setSize(300, 300),
  },
);

About

Hook for Google Picker API for React

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published