bottle-service

Instant web applications restored from ServiceWorker cache

Live demo - please use Chrome or Opera Desktop

Instant app demo - TodoMVC that is instant on page reload, hosted on free Heroku dyno, and needs Chrome browser for now

Browser support

Chrome

Nothing to do, ServiceWorker should be enabled by default

Firefox

Open about:config
Set the dom.serviceWorkers.enabled setting to true
Set the dom.serviceWorkers.interception.enabled setting to true

Api

This library attaches itself as bottleService object to the 'window'. Every time you want to store HTML snapshot for an element with id 'myApp', call

// "my-app-name" will be used in the future to allow separate parts of the
// page to be saved separately
// <div id="myApp"> // controlled by the web app </div>
// application has been rendered
bottleService.refill('my-app-name', 'myApp')

There are a couple of secondary api calls

bottleService.clear('my-app-name'); // delete whatever is stored in the ServiceWorker cache
bottleService.print('my-app-name'); // prints the stored text to console

Example

See dist/index.html that includes the "application" code. Every time the user clicks "Add item" button, the application code adds a new DOM node, then tells the bottle service to store the new snapshot

var applicationName = 'bottle-demo'
document.getElementById('add').addEventListener('click', function () {
  var el = document.getElementById('app')
  var div = document.createElement('div')
  var text = document.createTextNode('hi there')
  div.appendChild(text)
  el.appendChild(div)
  // store HTML snapshot
  bottleService.refill(applicationName, 'app')
})

When the page loads, the ServiceWorker will intercept index.html and will insert the saved HTML snapshot into the page before returning it back to the browser for rendering. Thus there is no page rewriting on load, no flicker, etc.

Instant web apps without page flicker or loading screens, blog post, source repo
Dynamic page rewriting on start hydrate-vue-todo
Fast application start from pre-rendered HTML hydrate-vdom-todo

Related projects using ServiceWorkers

express-service - run ExpressJS server inside ServiceWorker
service-turtle - Flexible http request interception using ServiceWorker

Small print

License: MIT - do anything with the code, but don't blame me if it does not work.

Spread the word: tweet, star on github, etc.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

bahmutov/bottle-service

bahmutov

Reviews

Repository Details