Rails::Protip

Tooltip gem based on the jQuery Protip plugin

• Ruby >= 3.0
• Rails >= 6.0

Add this line to your application's Gemfile:

gem 'rails-protip'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rails-protip

For Rails 6.x / 7.x with Sprockets:

Add this require statement to your application.js file:

//= require protip

And in your application.css file:

*= require protip

For Rails 7+ with Import Maps:

Add to your config/importmap.rb:

pin "protip", to: "protip.js"

Then import in your application.js:

import "protip"

For Rails with Webpacker/Shakapacker:

The gem works with the asset pipeline. If using Webpacker, you may need to configure it to load from the gem's assets directory.

Note: This gem requires jQuery. Make sure jQuery is loaded before protip.

<%= link_to "Go to the bar!", "#bar", class: "protip", "data-pt-title" => "You must be at least 18!" %>

You can also set default configuration in protip.yml under the config folder, example:

scheme: "orange"
skin: "square"

Support for animation is also provided, example:

<div class="protip" data-pt-animate="infinite bounce" data-pt-title="You must be at least 18!">Go to the bar!</div>

For further usage check http://protip.rocks

Version 1.0.0 introduces breaking changes to support modern Ruby and Rails versions:

• Ruby: Minimum version increased from 1.9.3 to 3.0
• Rails: Minimum version increased to 6.0

1. Ensure your application is running Ruby 3.0+ and Rails 6.0+
2. Update your Gemfile: gem 'rails-protip', '~> 1.0'
3. Run bundle update rails-protip
4. If using Rails 7+ with Import Maps, follow the new installation instructions above
5. Test your tooltips to ensure they still work as expected

See UPGRADE_GUIDE.md for detailed migration instructions.

Bug reports and pull requests are welcome on GitHub at https://github.com/ethirajsrinivasan/rails-protip. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Thanks to the Protip project for the original jQuery tooltip plugin.

The gem is available as open source under the terms of the MIT License.