ViewComponent (v4.0.0.rc2)

A framework for creating reusable, testable & encapsulated view components, built to integrate seamlessly with Ruby on Rails.

As of version 4, ViewComponent is in Long-Term Support and considered feature-complete.

What’s a ViewComponent?

ViewComponents are Ruby objects used to build markup. Think of them as an evolution of the presenter pattern, inspired by React.

ViewComponents are objects that encapsulate a template:

# app/components/message_component.rb
class MessageComponent < ViewComponent::Base
  def initialize(name:)
    @name = name
  end
end

<%# app/components/message_component.html.erb %>
<h1>Hello, <%= @name %>!<h1>

Which is rendered by calling:

<%# app/views/demo/index.html.erb %>
<%= render(MessageComponent.new(name: "World")) %>

Returning:

<h1>Hello, World!</h1>

Why use ViewComponents?

TL;DR

ViewComponents work best for templates that are reused or benefit from being tested directly. Partials and templates with significant amounts of embedded Ruby often make good ViewComponents.

Single responsibility

Rails applications often scatter view-related logic across models, controllers, and helpers, diluting their intended responsibilities. ViewComponents consolidate the logic needed for a template into a single class, resulting in a cohesive object that is easy to understand.

ViewComponent methods are implemented within the scope of the template, encapsulating them in proper object-oriented fashion. This cohesion is especially evident when multiple methods are needed for a single view.

Testing

ViewComponent was designed with the intention that all components should be unit tested. In the GitHub codebase, ViewComponent unit tests are over 100x faster than similar controller tests.

With ViewComponent, integration tests can be reserved for end-to-end assertions, with permutations covered at the unit level.

For example, to test the MessageComponent above:

class MessageComponentTest < GitHub::TestCase
  include ViewComponent::TestHelpers

  test "renders message" do
    render_inline(MessageComponent.new(name: "World"))

    assert_selector "h1", text: "Hello, World!"
  end
end

ViewComponent unit tests leverage the Capybara matchers library, allowing for complex assertions traditionally reserved for controller and browser tests.

Data Flow

Traditional Rails templates have an implicit interface, making it hard to reason about their dependencies. This can lead to subtle bugs when rendering the same template in different contexts.

ViewComponents use a standard Ruby initializer that clearly defines what’s needed to render, making reuse easier and safer than partials.

Performance

Based on several benchmarks, ViewComponents are ~2.5x faster than partials:

Comparison:
  component:     6498.1 i/s
    partial:     2676.5 i/s - 2.50x  slower

Code quality

Template code often fails basic Ruby standards: long methods, deep conditional nesting, and mystery guests abound.

ViewComponents are Ruby objects, making it easy to follow (and enforce) code quality standards.

Contributors

Hundreds of people have contributed to ViewComponent, including:

Who uses ViewComponent?

• Aboard HR
• Arrows
• Aluuno
• Avo Admin for Rails
• Bearer (70+ components)
• Brightline
• Buildkite
• Bump.sh
• Causey (100+ components)
• CharlieHR
• City of Paris
• Clio
• Cometeer
• Consul
• Content Harmony
• Cults.
• Defacto
• DotRuby
• Eagerworks
• FlightLogger
• Framework
• FreeAgent
• FreeATS
• G2 (200+ components)
• Getblock
• GitHub (900+ components used 15k+ times)
• GitLab
• HappyCo
• HomeStyler AI
• Keenly (100+ components)
• Kicksite
• Krystal
• Launch Scout
• Learn To Be (100+ components)
• Litmus
• Login.gov
• Mission Met Center
• Mon Ami
• Nikola Motor (50+ components and counting)
• Niva
• OBLSK
• openSUSE Open Build Service
• OpenProject
• Ophelos
• Orbit
• PeopleForce
• PLT4M
• Podia
• PrintReleaf
• Project Blacklight
• QuickNode
• Room AI
• SearchApi
• Simundia
• Skroutz
• Shogun
• SpendHQ
• Spina CMS
• Spring
• Startup Jobs
• Teamtailor
• Topkey
• Web3 Jobs
• Wecasa
• WIP
• Within3
• Workbrew
• Wrapbook
• Yobbers

Using ViewComponent? Send a pull request to update this list! You can also check out how various projects use ViewComponent.

---

Getting started →