README.md

Highway

Highway is a lightweight (2.2ko gzipped), robust, modern and flexible library that will let us create AJAX navigations with beautiful transitions on our websites. It's been a while we were trying to build this kind of library to fits our needs at Dogstudio and we now finally released it!

Table of Content

• Guide
• Examples
• Demos
• Support
• Roadmap
• Releases
• License

Support

• Google Chrome
• Firefox
• Edge
• Safari 6.2+
• Internet Explorer 10+ (+ whatwg-fetch)

Roadmap

• More Unit Tests
• More Examples
• More Demos

Releases

2.0.x

• 🎉 Add demo website
• 🎉 Add Core.redirect(href) method
• 🎉 Add dynamic import for renderers
• 🎨 Update informations sent with events
• 🎨 Rename Core.bind() into Core.attach()
• 🎨 Rename Core.unbind() into Core.dettach()
• 🎨 Rename Renderer.root into Renderer.view
• 🎨 Replace Renderer.page by Renderer.properties
• 🐛 Fix NAVIGATE_IN event that was fired too early
• 🐛 Fix the view swapping that causes so issues
• 🐛 Fix issue #9
• 🐛 Fix issue #12
• ✨ Improve overall code
• 🔥 Remove NAVIGATE_ERROR event
• 🔥 Clean up README.md

1.3.x

• 🎉 Add ES5 version in dist/es5 folder
• 🎉 Add the Basic Anchor example
• 🎉 Add the Basic Polyfill example
• 🎉 Add unit tests
• 🔥 Remove modes that weren't convincing
• ✨ Improve code and weight with ES2016+ features
• ✨ Improve events
• ✨ Improve transitions
• ✨ Improve documentation
• 🎨 Rename renderers init method to setup method
• 🐛 Quick fix for URLs with parameters
• 🐛 Fix events
• 🐛 Fix helpers
• 🐛 Skip link with javascript: in href

1.2.x

• 🎉 Add NAVIGATE_CALL, NAVIGATE_IN, NAVIGATE_OUT events
• 🎉 Add more variables available in Highway.Renderer
• ✨ Improve renderers
• ✨ Improve documentation

1.1.x

• 🎉 Add modes
• ✨ Improve documentation

1.0.x

• 🎉 Add Highway.Transition

0.0.x

• 🚀 First release

Contributors

• Anthodpnt

License

See the LICENSE file for license rights and limitations (MIT).