PolarisFormBuilder

Use Shopify Polaris Web Components as a Rails form builder, while keeping Rails form semantics.

• Polaris Web Components docs: https://shopify.dev/docs/api/app-home/polaris-web-components

• Provides PolarisFormBuilder::FormBuilder as a drop-in Rails form builder.
• Provides polaris_form_with for explicit per-form opt-in.
• Integrates via Rails Engine so helpers are available in ActionView.
• Maps model validation errors to Polaris component error attributes.
• Preserves Rails helper behavior (name, value, checked, etc.) by building on top of super.

• Ruby >= 3.1.0
• Rails app using form_with / ActionView::Helpers::FormBuilder

bundle add polaris_form_builder
bundle install

<%= polaris_form_with model: @user do |f| %>
  <%= f.text_field :email, placeholder: "Enter email" %>
  <%= f.password_field :password %>
  <%= f.text_area :bio %>
  <%= f.check_box :agree_terms %>
  <%= f.submit "Create Account" %>
<% end %>

# config/application.rb (or environment files)
config.action_view.default_form_builder = PolarisFormBuilder::FormBuilder

Then regular form_with will use Polaris components automatically.

<%= form_with model: @user do |f| %>
  <%= f.text_field :email %>
  <%= f.password_field :password %>
  <%= f.submit %>
<% end %>

• text_field
• number_field
• email_field
• password_field
• url_field
• search_field
• color_field
• date_field
• file_field (drop_zone alias)
• text_area
• check_box
• select
• submit

• drop_zone
• money_field
• color_picker
• date_picker
• switch
• choice_list

When your model has errors, corresponding Polaris components receive error automatically.

class User < ApplicationRecord
  validates :email, presence: true
end

<%= polaris_form_with model: @user do |f| %>
  <%= f.text_field :email %>
<% end %>

If @user.errors[:email] is present, the rendered Polaris field gets an error attribute.

bin/setup
bin/rubocop
rake test
bin/ci

Useful commands:

rake test_unit
rake test_integration
rake test_playground
bin/console

1. Update lib/polaris_form_builder/version.rb.
2. Update CHANGELOG.md.
3. Run bin/ci.
4. Publish:

bundle exec rake release

Issues and pull requests are welcome:

This project follows the Contributor Covenant Code of Conduct.

Released under MIT. See LICENSE.txt.