Turbo React Save
A JavaScript library that transitions between static HTML pages on navigation; no app server required.
TurboReact
TurboReact applies only the differences between two HTML pages when navigating with links rather than create a new document, which enables CSS transitions between pages without needing a server.
Installation & Usage
TurboReact is a plugin for Turbolinks,
which means Turbolinks is required. Include both Turbolinks and TurboReact in
the <head> of every document on your site.
Ruby on Rails
-
Add the
turbo_react-railsgem to your Gemfile:gem 'turbo_react-rails' -
Install the updated set of gems:
$ bundle install -
Require the "turbo-react" library after "turbolinks" on every page, for example in "application.js" if it is on every page:
//= require turbolinks //= require turbo-react
Plain HTML and Other Frameworks
-
Get turbo-react via NPM or download the latest release from GitHub:
$ yarn install turbo-reactor
$ curl https://raw.githubusercontent.com/ssorallen/turbo-react/v0.9.0/public/dist/turbo-react.min.js -
Include turbo-react in the
<head>of each page of the site after Turbolinks:<!DOCTYPE html> <html> <head> ... <script src="path/to/turbolinks.js"></script> <script src="path/to/turbo-react.min.js"></script> </head> <body> ... </body> </html>
Opting out of Turbolinks & TurboReact
Add a
data-no-turbolink attribute
to any link that should load normally without being intercepted by Turbolinks
and TurboReact. This feature is inherited from TurboReacts's use of Turbolinks.
<a href="/foo/bar.html" data-no-turbolink>
Skip Turbolinks and TurboReact
</a>
Examples
Transitioning Background Colors
Navigating between page1 and page2 shows a skyblue background and a yellow
background that changes at once. After putting TurboReact in the <head>,
navigating between the pages will transition between the background colors
because TurboReact will add and remove the class names rather than start a new
document.
/* style.css */
body {
height: 100%;
margin: 0;
transition: background-color 0.5s;
width: 100%;
}
.bg-skyblue {
background-color: skyblue;
}
.bg-yellow {
background-color: yellow;
}
<!-- page1.html -->
<body class="bg-skyblue">
<a href="page2.html">Page 2</a>
</body>
<!-- page2.html -->
<body class="bg-yellow">
<a href="page1.html">Page 1</a>
</body>
How it Works
Demo: https://turbo-react.herokuapp.com/
"Re-request this page" is just a link to the current page. When you click it, Turbolinks intercepts the GET request and fetchs the full page via XHR.
The panel is rendered with a random panel- class on each request, and the progress bar gets a random widthX class.
With Turbolinks alone, the entire <body> would be replaced, and transitions
would not happen. In this little demo though, React adds and removes
classes and text, and the attribute changes are animated with CSS transitions.
The DOM is otherwise left in tact.
The Code
TurboReact turns the <body> into a React element and re-renders it after
Turbolinks intercepts link navigations via XMLHttpRequest:
turbo-react.js
Running locally
-
Clone this repo
$ git clone https://github.com/ssorallen/turbo-react.git -
Install dependencies
$ bundle install $ yarn install -
Run the server and watch JS changes
$ bundle exec unicorn $ yarn watch -
Visit the app: http://localhost:9292
Open Source Agenda Badge
