Primer ViewComponents

ViewComponents for the Primer Design System

Note: This library is in pre-release development and should not be considered stable.

Design philosophy

Primer ViewComponents aims to mimic the API of Primer Components, while using Primer CSS under the hood.

Installation

In Gemfile, add:

gem "primer_view_components"

In config/application.rb, add after the application definition

require "primer/view_components/engine"

Usage

Built-in styling arguments

Primer components should be styled using the built-in arguments when possible. Most Primer utility classes for spacing, alignment, display, and colors have equivalent component arguments.

Example label built with Primer CSS:

<span title="Label: Suggested" class="Label Label--outline Label--outline-green ml-2 v-align-middle">Suggested</span>

The same label using Primer::LabelComponent:

<%= render Primer::LabelComponent.new(ml: 2, vertical_align: :middle, scheme: :green, title: "Label: Suggested") do %>
  Suggested
<% end %>

Some components have their own specific arguments, but they can all be styled with the following arguments.

Component argument Primer class Example
m m-<value> m: 4.m-4
my my-<value> my: 4.my-4
mx my-<value> mx: 4.mx-4
mt mt-<value> mt: 4.mt-4
mb mb-<value> mb: 4.mb-4
ml ml-<value> ml: 4.ml-4
mr mr-<value> mr: 4.mr-4
p p-<value> p: 4.p-4
py py-<value> py: 4.py-4
px py-<value> px: 4.px-4
pt pt-<value> pt: 4.pt-4
pb pb-<value> pb: 4.pb-4
pl pl-<value> pl: 4.pl-4
pr pr-<value> pr: 4.pr-4
pr pr-<value> pr: 4.pr-4
f f-<value> f: 4.f-4
color color-<value> color: :red_500.color-red-500
text text-<value> text: :green.text-green
bg bg-<value> bg: :blue_light.bg-blue-light
display d-<value> display: :none.d-none
float float-<value> float: :right.float-right
vertical_align v-align-<value> vertical_align: :baseline.v-align-baseline
text_align text-<value> text_align: :right.text-right
font_size f<value> font_size: 4.f4
font_weight text-<value> font_weight: :bold.text-bold
border border-<value> border: :bottom.border-bottom
border_color border-<value> border: :green.border-green
word_break wb-<value> word_break: :break_all.wb-break-all
direction flex-<value> direction: :row.flex-row
justify_content flex-justify-<value> justify_content: :center.flex-justify-center
align_items flex-items-<value> align_items: :baseline.flex-items-baseline
box_shadow box-shadow-<value> box_shadow: :medium.box-shadow-medium

Boolean arguments

Component arguments True False
underline underline: true.text-underline underline: false.no-underline
top n/a top: false.top-0
bottom n/a bottom: false.bottom-0
left n/a left: false.left-0
right n/a right: false.right-0

Responsive arguments

Different classes can be used for different breakpoints just like in Primer CSS. Simply use an array with the four values required for [none, small, medium, large]. If no breakpoint is needed for a breakpoint, pass nil.

Example heading built with Primer CSS:

<h1 class="mt-0 mt-lg-4">Hello world</h1>

The same label using Primer::HeadingComponent:

<%= render Primer::HeadingComponent.new(mt: [0, nil, nil, 4]) do %>
  Hello world
<% end %>

Contributing

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

Setting up

Run

script/setup

to install all necessary dependencies

Running tests

To run the full test suite:

bundle exec rake

Storybook

We recommend having overmind installed to run both rails and storybook, but it is not required.

To run storybook:

script/storybook

Developing with another app

In your Gemfile, change:

gem "primer_view_components"

to

gem "primer_view_components", path: "path_to_the_gem" # e.g. path: "~/primer/view_components"

Then, bundle install to update references. You'll now be able to see changes from the gem without having to build it. Remember that restarting the Rails server is necessary to see changes, as the gem is loaded at boot time.

To minimize the number of restarts, we recommend checking the component in Storybook first, and then when it's in a good state, you can check it in your app.

License

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