Skip to content

telecta/panels_for

Repository files navigation

PanelsFor

Build Status Code Climate Test Coverage Gem Version Dependency Status

ActionView Helper for generating Bootstrap panels.

Installation

Add this line to your application's Gemfile:

gem 'panels_for'

And then execute:

$ bundle

Or install it yourself as:

$ gem install panels_for

Usage

<%= panels_for @project do |b| %>
  <%= b.panel :managers, icon: 'users', id: :users do %>
    Content goes here!
  <% end %>
  <%= b.panel :graphs, icon: 'line-chart', collapse: true do %>
    Graphs here!
  <% end %>
  <%= b.panel :files, title: t('.attachments'), icon: 'file', collapse: true, collapsed: true %>
    Files here!
  <% end %>
<% end %>

Options

Possible options for #panel:

  • :icon - Font Awesome icon to use..
  • :collapse - Make panel collapsable.
  • :collapsed - Draw panel collapsed.
  • :id - ID of HTML element.
  • :title - Use as title instead of the autogenerated one.

Development

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

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.

Contributing

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

Testing

To test against all supported Rails versions, run:

appraisal rake test

To update all supported Rails to latest patch version:

appraisal update

License

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