2020-04-04 02:18:47 -04:00
---
page_type: sample
products:
- office-sp
languages:
- javascript
- typescript
extensions:
contentType: samples
technologies:
- SharePoint Framework
platforms:
- react
createdDate: 3/1/2018 12:00:00 AM
---
2020-11-08 23:31:49 -05:00
# Offline First using LocalForage, Whatwg-Fetch, ES6-Promise
2018-02-26 03:30:58 -05:00
## Summary
2021-04-26 02:08:59 -04:00
Sample Web part that demonstrates how to use offline storage in a way that is more
2018-02-26 03:30:58 -05:00
offline first.
2021-04-26 02:08:59 -04:00
This web part would not be possible without the great tools provided, please
2018-02-26 03:30:58 -05:00
read the documentation for
* [LocalForage ](https://github.com/localForage/localForage )
* [ES6-Promise ](https://github.com/stefanpenner/es6-promise )
* [Whatwg-Fetch ](https://github.com/whatwg/fetch )
2022-01-16 13:41:07 -05:00
2018-02-26 03:30:58 -05:00
2021-11-07 01:33:53 -05:00
## Compatibility
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
2018-02-26 03:30:58 -05:00
## Applies to
2020-06-09 03:09:22 -04:00
* [SharePoint Framework Developer Preview ](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview )
* [Office 365 developer tenant ](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant )
2018-02-26 03:30:58 -05:00
## Solution
Solution |Author(s)
--------------------|---------
react-offline-first |[Austin Breslin](https://github.com/AustinBreslinDev)
## Version history
Version |Date | Comments
------- |---- | --------
0.0.1 |17/Feb/18 | Got the HTTP Requests to work.
2020-04-04 02:18:47 -04:00
0.0.2 |17/Feb/18 | Separated interfaces into their own files.
2018-02-26 03:30:58 -05:00
0.0.3 |18/Feb/18 | Updated JSDocs, and and created readme.
2021-04-26 02:08:59 -04:00
2018-02-26 03:30:58 -05:00
## Minimal Path to Awesome
- Clone this repo
- In the command line run:
- `npm install`
- `tsd install`
- `gulp serve`
- Open the *workbench* on your Office 365 Developer tenant
- Test out the web part
## Features
2021-04-26 02:08:59 -04:00
This web part demonstrates using the OfflineFirstHTTPService how to do offline
2018-02-26 03:30:58 -05:00
first HTTP Requests.
HTTP Get requests are first retrieved from an offline storage system. Either
localStorage, IndexedDB, WebSQL or SessionStorage, but maybe not in that order.
Then the live request is using fetch, then stored locally, errors are placed into
a queue for when available.
HTTP Posts/Updates/Deletes are executed differently to GET requests, they always
make a HTTP request using fetch, but on failure are added to the queue.
The Queue system collects all failed HTTP Requests and when the user is online
will try to make the requests again, all requests are async so will not cause
any blocking for the user.
This Web Part illustrates the following concepts on top of the SharePoint Framework:
- Using offline first techniques, store locally, retrieve locally before making
HTTP requests.
- Async looping, can be found in the Queue System.
- Performance techniques for browsers, async looping does not block render,
2020-04-04 02:18:47 -04:00
using local storage first reduces the time to draw the initial page load.
2018-02-26 03:30:58 -05:00
2021-11-07 01:54:14 -05:00
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
2021-12-20 10:25:30 -05:00
< img src = "https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-offline-first" / >
