Tiny Component

Tiny Component is a simple, fast, and lightweight way to organize view components in a Ruby on Rails application. It is faster and provides a better structure and logic organization compared to templates or partials.

Installation

Add this to your Gemfile and run bundle install.

gem "tiny_component"

Example

app/components/button_component.rb

class ButtonComponent < TinyComponent::Base
  include ActionView::Helpers::FormTagHelper

  def initialize(text:)
    @text = text
  end
end

app/view/components/button.html.erb

<%= button_tag @text, class: "px-4 py-2 rounded-lg bg-blue-500 text-white" %>

Usage:

<%= component :button, text: "Hello" %>

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.

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 the created tag, and push the .gem file to rubygems.org.

Contributing

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

License

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