useGoogleSheets
A React Hook wrapper library for google-sheets-mapper for getting data from Google Sheets API v4
Installation
Package can be added using yarn:
yarn add use-google-sheetsOr, use NPM:
npm install use-google-sheetsUMD build available on unpkg.
Usage
- Go to Google Cloud Console to get API key for Google Sheets API.
- Create a Google Sheet and add some data. See example sheet.
- Share it with "Anyone with this link can view".
- Get sheet id from url of the sheet.
https://docs.google.com/spreadsheets/d/[THIS-IS-THE-SHEET-ID]/- I suggest adding API key and sheet id to
.envfile
Examples
Get data from all sheets inside the spreadsheet
import useGoogleSheets from 'use-google-sheets';
const App = () => {
const { data, loading, error } = useGoogleSheets({
apiKey: process.env.REACT_APP_GOOGLE_API_KEY,
sheetId: process.env.REACT_APP_GOOGLE_SHEETS_ID,
});
if (loading) {
return <div>Loading...</div>;
}
if (error) {
return <div>Error!</div>;
}
return <div>{JSON.stringify(data)}</div>;
};Get data from specific sheets inside the spreadsheet
Don't use single quotes on sheet names, they will be removed because when using space in sheet name it will be returned wrapped with single quotes and plugin will remove them for clean string id.
import useGoogleSheets from 'use-google-sheets';
const App = () => {
const { data, loading, error } = useGoogleSheets({
apiKey: process.env.REACT_APP_GOOGLE_API_KEY,
sheetId: process.env.REACT_APP_GOOGLE_SHEETS_ID,
sheetsOptions: [{ id: 'Sheet1' }],
});
if (loading) {
return <div>Loading...</div>;
}
if (error) {
return <div>Error!</div>;
}
return <div>{JSON.stringify(data)}</div>;
};Refetch data from all sheets inside the spreadsheet
import useGoogleSheets from 'use-google-sheets';
const App = () => {
const { data, loading, error, refetch } = useGoogleSheets({
apiKey: process.env.REACT_APP_GOOGLE_API_KEY,
sheetId: process.env.REACT_APP_GOOGLE_SHEETS_ID,
});
if (loading) {
return <div>Loading...</div>;
}
if (error) {
return <div>Error!</div>;
}
return (
<div>
<div>{JSON.stringify(data)}</div>
<button onClick={refetch}>Refetch</button>
</div>
);
};API Documentation
The useGoogleSheets hook takes an object with three properties:
| Name | Value |
|---|---|
| apiKey | string |
| sheetId | string |
| sheetsOptions | array |
apiKeyis a Google Sheets API v4 key from Google Cloud Console.sheetIdis the id of the sheet.sheetsOptionsis an array of specific objects{ id, headerRowIndex }. Can be left out then it will fallback to all sheets inside the spreadsheet and use first row from sheet as header.
Exposed Data
The hook produces an HookState object:
const { data, loading, error, refetch, called } = useGoogleSheets({
apiKey,
sheetId,
});| Name | Value |
|---|---|
| data | array |
| loading | boolean |
| error | null or object |
| refetch | function |
| called | boolean |
datais an array of mapped data objects.
[
{
id: 'Sheet1',
data: [
{ key: 'language', value: 'et' },
{ key: 'title', value: 'Test sheet' },
],
},
];loadinglets you know whether data is being fetched and mapped.errorlets you know when there is something wrong. It returns an error object where you can get specific error properties fromerror.response
{
status: '404',
statusText: '',
url: 'https://sheets.googleapis.com/v4/spreadsheets/...',
}Migration from v1 to v2
- Change
sheetsNamesarray of string tosheetsOptionsarray of objects with{ id: 'sheetName' }