hydrate-app
Quick app pre-loading using saved HTML snapshot
Last updated 4 years ago by bahmutov .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install hydrate-app 
SYNC missed versions from official npm registry.

hydrate-app

Quick app pre-loading using saved HTML snapshot

NPM

Build status semantic-release manpm

demo

See a larger Vue.js demo and its source. See the hydration in action on my own website glebbahmutov.com, notice how the list of projects when you refresh appears almost instantly, while the main application still loads.

Read the blog post Hydrate your apps

Install

npm install --save hydrate-app

Include the script right after the web app element - this is important to prevent the content after the element from shifting.

<div id="myApp">...</div>
<script src="dist/hydrate-app.js"
  id="myApp"
  verbose="true"
  on="hydrate"
  verbose-ui="true"></script>

API

Script attributes

  • id - the ID of the web application element to replace
  • verbose - if set to "true" prints console log messages
  • verbose-ui - show user popups
  • on - optional. If exists and set to string <name>, the hydrate-app factory function will look for window[<name>] flag to decide if it needs to hydrate. A good way to compare normal startup vs hydrated.

JavaScript api

Once the script runs, it creates a global object called bottle. The bottle has only a few methods for saving, loading and updating the HTML snapshot. The two most important ones to call from your application are:

  • bottle.drink() - call when your application has initialized and rendered itself.
  • bottle.refill(defer) - call every time you want to take DOM snapshot. This snapshot will be rendered on the next page load.

The argument defer postpones the refill by scheduling it on the event queue - for some frameworks this allows to actually update the DOM.

Details

You can find the current (if any) HTML snapshot in the localStorage under bottle- + ID key. If you want to erase the current snapshot, you can use bottle.recycle() method.

The hydration script removes CSS class name "hidden" from the web application's element. This is useful to remove the flash of the template and flicker. I recommend

<style>
.hidden {
  display: none;
}
</style>
<body>
  <div id="myApp" class="hidden">...</div>
</body>

Small print

Author: Gleb Bahmutov © 2015

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

Copyright (c) 2015 Gleb Bahmutov

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.

Current Tags

  • 1.8.0                                ...           latest (4 years ago)

11 Versions

  • 1.8.0                                ...           4 years ago
  • 1.7.0                                ...           4 years ago
  • 1.6.1                                ...           4 years ago
  • 1.6.0                                ...           5 years ago
  • 1.5.0                                ...           5 years ago
  • 1.4.1                                ...           5 years ago
  • 1.4.0                                ...           5 years ago
  • 1.3.0                                ...           5 years ago
  • 1.2.0                                ...           5 years ago
  • 1.1.0                                ...           5 years ago
  • 1.0.0                                ...           5 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 3
Dependencies (0)
None
Dev Dependencies (10)
Dependents (2)

Copyright 2014 - 2016 © taobao.org |