Nprogress Rails

screenshot of Nprogress Rails

Slim progress bars for Ajax'y applications. Inspired by Google, YouTube, and Medium for the Rails Asset Pipeline (and some turbolinks/pjax/angular love)

Overview

The nprogress-rails gem is a powerful tool that integrates the popular NProgress library into your Rails application, allowing for a smooth and visually appealing progress indicator during page loads and Ajax requests. With its simple setup and customizable features, this gem enhances the user experience by providing feedback on ongoing processes, making your applications feel more responsive.

The gem includes version 0.2.0 of the NProgress library created by rstacruz, and it caters to different setups depending on the nature of your Rails application, whether you're using Turbolinks, jQuery, or Angular.js. With just a few lines of code in your Gemfile and JavaScript files, you can have a functional progress indicator up and running in no time.

Features

  • Easy Installation: Simply add the nprogress-rails gem to your Gemfile and execute a command to get started quickly.
  • Turbolinks Compatibility: Seamlessly integrates with Turbolinks to show progress on page loads; additional support for Turbolinks 5 is also included.
  • Ajax Support: Automatically triggers the NProgress bar during Ajax requests, providing visual feedback as data is being fetched without requiring manual intervention.
  • Customizable Progress Bar: Change the color and style of your progress bar using SASS, allowing for a look that fits your application's design.
  • Multiple Integrations: Works with jQuery, Prototype, and Angular.js, making it versatile for various frameworks and libraries.
  • Error Handling Guidance: Offers tips for troubleshooting progress display issues, ensuring you can resolve problems easily if they arise.
  • Open for Contributions: Provides a clear path for developers to contribute to the project by forking and creating pull requests, fostering community engagement.