Popcircle

This gem adds jquery.easing and jquery.popcircle to your application and provides a view helper to add a radial menu with images or icons as the links surrounding the main trigger.

NOTE: this is VERY much still in progress. I don't suggest using any of this for anything other than throw-away projects.

Installation

Add this line to your application's Gemfile:

gem 'popcircle'

And then execute:

$ bundle

Or install it yourself as:

$ gem install popcircle

Usage

First, make sure your application.js file includes the following:

//= require popcircle/popcircle

Second, you can include something like this in your HTML

<%= popcircle(images: %w(one.png two.png three.png four.png five.png)) %>

You can also use font awesome icons! Thanks font-awesome-rails!

<%= popcircle(icons: %w(facebook twitter google linkedin github)) %>

<%= popcircle(stacked: %w(facebook twitter google linkedin github)) %>

TODO

• get helper tests back to running
• get rake test to run both gem tests and dummy app tests correctly
• improve helper method
• allow trigger background image to be configurable
• allow size to be configurable

Contributing

I could use some help!

Bug reports and pull requests are welcome on GitHub at https://github.com/jakehockey10/popcircle. 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.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Note

I have begun the development of this app with integration tests in a dummy rails app inside the test folder of the gem's project. The integration tests in this rails app should be run from the root of the project.

Installing

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

License

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