VCFB

FormBuilder for Rails using ViewComponent

VCFB provides a FormBuilder for use with ViewComponent. It was inspired by ViewComponent::Form, but with the goal to make it easy to apply styling and other formatting within a component's .html.erb file (rather than in Ruby code).

To further support this goal, if the application includes the TagOptions gem, the vcfb:components will make use of it when saving options and html_options hashes.

Installation

Add this line to your application's Gemfile:

gem "vcfb"

And then execute:

bundle install

Usage

Generate a set components to use with VCFB::FormBuilder

rails generate vcfb:components

The generator will install view components for ALL of the form elements supported by the version of Rails installed. By default, all of the components will be namespaced in module Form.

To generate components in a different namespace, use the --namespace option

rails generate vcfb:components --namespace inline_form

This will generate all the components under module InlineForm. To make use of these namespaced components, create a custom FormBuilder in your application inheriting from VCFB::FormBuilder.

class InlineFormBuilder < VCFB::FormBuilder
  self.namespace = "inline_form"
end

To render forms using the generated components, sepecify VCFB::FormBuilder or a class that inherits from it when using form_with or form_for.

<%= form_with model: @author, builder: VCFB::FormBuilder do |form| %>
  <%= form.label :name %>
  <%= form.text_field :name %>
<% end %>

Generated components support before_initialize, after_initialization, and around_initialize callbacks to minimize the need to override the initlialize methods.

module Form
  module Label
    after_initialize :set_component_options

    private

    def set_component_options
      @size = @options.delete(:size) || :default
    end
  end
end

By default, components will inherit from ApplicationComponent if it exists or ViewComponent::Base if it does not. If you wish to change this behavior, generate an initializer and specify the parent_component.

rails generate vcfb:initializer

VCFB.configure do |config|
  config.parent_component = "MyCustomBaseComponent"
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/rspec to run the tests. You can also run:

• bin/console for an interactive prompt that will allow you to experiment
• bin/rubocop to run RuboCop to check the code style and formatting

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/wamonroe/vcfb.

License

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