https://github.com/codediodeio/hotroute

https://github.com/codediodeio/hotroute

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/codediodeio/hotroute
• Owner: codediodeio
• Created: 2018-12-19T17:05:29.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-08T17:37:48.000Z (about 4 years ago)
• Last Synced: 2024-09-04T17:14:20.972Z (29 days ago)
• Language: TypeScript
• Size: 58.6 KB
• Stars: 8
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# hotroute ⚡

Status: Experimental 🧫

An 2.5kB zero-config router and prefetcher for static or server-rendered sites.

## Why?

HTTP is stateless. What if you could maintain state between full page changes without building an SPA? 

Ideal for static or server-rendered web apps using web components that want super fast page changes without losing stateful data in JavaScript. Expect page transitions **under 50ms** for an average blog post on an average network. 

## How?

(1) It prefetches visible links in the page with intersection observer, thanks to [quicklink](https://github.com/GoogleChromeLabs/quicklink). (2) Intercepts click and popstate events, then updates the HTML5 history on qualifed route changes.  (3) Swaps the body out, while preserving most of the head (will change title and meta tags automatically).

This means if you use a global state management system, i.e. Angular DI or React Context or just plain old JS, your static content will change, but your web components will maintain state across HTTP requests. 

It will fallback to standard naviation if `window.history` does not exist. 

## QuickStart

```

npm i hotroute

```

```js

import hotroute from hotroute;

const router = hotroute();

```

That's it. Magic (maybe too much).

## Advanced Usage

```js

// with opts 

const router = hotroute({ log: true, prefetch: true });

// Navigate manually

router.go('/somewhere');

// Listen to events

window.addEventListener('router:fetch', showLoader);

window.addEventListener('router:end', hideLoader);

```

### What is happening in the DOM?

Here's how things change in the DOM on a navigation event. 

```html

    

    

    

    Document 

    

     

    

     

    

    

    

     

```

### Caveats

- Body scripts will never run (but you should be using defer anyway)