npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hydrate-app

v1.8.0

Published

Quick app pre-loading using saved HTML snapshot

Downloads

35

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

bahmutovbahmutov

Keywords

webappwebapplicationperformanceloadloader

Readme

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.