Highway

Highway is a lightweight, 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
• 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.1.x

• :lock: Update dependencies for security purposes
• :tada: Add trigger information in transitions and events
• :tada: Add contextual transitions
• :tada: Add overlapping transitions
• :sparkles: Add Prefetch example to documentation
• :sparkles: Improve transitions and events parameters for destructuring
• :sparkles: Improve documentation website
• :sparkles: Improve Core.redirect(href, transition) method
• :sparkles: Improve Core.attach(links) method
• :sparkles: Improve Core.detach(links) method
• :art: Invert from and to parameters of the NAVIGATE_END event
• :bug: Fix issue #44

2.0.x

• :tada: Add documentation website
• :tada: Add Core.redirect(href) method
• :tada: Add dynamic import for renderers
• :art: Update informations sent with events
• :art: Rename Core.bind() into Core.attach()
• :art: Rename Core.unbind() into Core.dettach()
• :art: Rename Renderer.root into Renderer.view
• :art: Replace Renderer.page by Renderer.properties
• :bug: Fix pushState location in the process
• :bug: Fix CMD/CTRL + click behavior of browsers
• :bug: Fix NAVIGATE_IN event that was fired too early
• :bug: Fix the view swapping that causes so issues
• :bug: Fix page caching with queries
• :bug: Fix issue #9
• :bug: Fix issue #12
• :sparkles: Improve overall code
• :fire: Remove NAVIGATE_ERROR event
• :fire: Clean up README.md

1.3.x

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

1.2.x

• :tada: Add NAVIGATE_CALL, NAVIGATE_IN, NAVIGATE_OUT events
• :tada: Add more variables available in Highway.Renderer
• :sparkles: Improve renderers
• :sparkles: Improve documentation

1.1.x

• :tada: Add modes
• :sparkles: Improve documentation

1.0.x

• :tada: Add Highway.Transition

0.0.x

• :rocket: First release

Contributors

• Anthodpnt
• ThaoD5
• joshkirk-zero

License

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