Background

The background kit is used for adding a background to a page or to any container. Instead of adding a custom class to give something a background, you can now wrap the elements in the background kit and use the background_color prop to assign its color. The colors that you can choose from for the background_color prop are: gradient, dark, light, white, status colors, product colors, and category colors.

The custom_color prop allows you to pass a hex value (ex. "#e43718") in place of background_color. It is not case sensitive, but needs to start with #. This prop exists primarily for use in microsites and very specific situations. Avoid using unless absolutely necessary to maintain continuity.

Default

By default, the Background kit sets background color to 'light' as seen here.

<%= pb_rails("background", props: { padding: "xl" }) do %>

<% end %>

White

  <%= pb_rails("background", props: { background_color: "white", padding: "xl" }) do %>
    
  <% end %>

Gradient

<%= pb_rails("background", props: { background_color: "gradient", padding: "xl" }) do %> 

<% end %>

Image

Background Kit Image

We cannot seek achievement for ourselves and forget about progress and prosperity for our community... Our ambitions must be broad enough to include the aspirations and needs of others, for their sakes and for our own. -Cesar Chavez

To add a lazyload on the background image simply use the transition prop and one of the three string options "fade", "blur", or "scale".

<%= pb_rails("background", props: { classname: "background-image", image_url: "https://images.unsplash.com/photo-1528459801416-a9e53bbf4e17?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1000&q=80", padding: "lg" }) do %>
  <%= pb_rails("flex", props: { horizontal: "center", orientation: "column", margin_bottom: "xl" }) do %>
    <%= pb_rails("flex/flex_item") do %>
      <%= pb_rails("title", props: { dark: true, size: 1, text: "Background Kit Image" })%>
    <% end %>
    <%= pb_rails("flex/flex_item", props: { padding: "lg" }) do %>
      <%= pb_rails("card", props: { shadow: "deepest" }) do %>
        We cannot seek achievement for ourselves and forget about progress and prosperity for our community... Our ambitions must be broad enough to include the aspirations and needs of others, for their sakes and for our own.
        -Cesar Chavez
      <% end %>
    <% end %>
  <% end %>
<% end %>

<%= pb_rails("flex", props: { margin_top: "lg" }) do %>
  <%= pb_rails("flex/flex_item", props: {fixed_size: "250px"}) do %>
    <%= pb_rails("select", props: {
    id: "transition-dropdown",
    label: "",
    blank_selection: "Select a Transition...",
    options: [
        {
          value: 'fade',
        },
        {
          value: 'blur',
        },
        {
          value: 'scale',
        },
    ]
    }) %>
  <% end %>
<% end %> 

<script>
    window.addEventListener('DOMContentLoaded', () => {
        const transitionDropdown = document.querySelector("#transition-dropdown")
        var option = ''

        transitionDropdown.addEventListener('change', function() {
          if (this.value === '') {
            (transitionDropdown).className = (transitionDropdown).className + ' _disabled'
          } else {
            (transitionDropdown).removeAttribute("disabled");
            (transitionDropdown).className = (transitionDropdown)
            option = this.value
          }
        });

        const updateTransition = (transition) => {
          const imageTransition = document.querySelector('.background-image')
            imageTransition.classList.remove("fade", "blur", "scale", "lazyloaded")
            imageTransition.classList.add(transition, "lazyload")   
        } 
        (transitionDropdown).addEventListener('change', function() {
          updateTransition(option)
        })
    });
</script>

Status

Status colors can be passed into the background kit. success, success_secondary, warning, warning_secondary, error, error_secondary, info, info_secondary, neutral, neutral_secondary, primary, and primary_secondary

<%= pb_rails("flex", props: {gap: "md", justify: "center", wrap: true}) do %>
  <%= pb_rails("background", props: { background_color: "success", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "success_secondary", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "warning", padding: "xl" }) do %> <% end %>
  <br>
   <%= pb_rails("background", props: { background_color: "warning_secondary", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "error", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "error_secondary", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "info", padding: "xl" }) do %> <% end %>
  <br>
    <%= pb_rails("background", props: { background_color: "info_secondary", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "neutral", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "neutral_secondary", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "primary", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "primary_secondary", padding: "xl" }) do %> <% end %>
<%end%>

Status Subtle

Status Subtle colors can be passed into the background kit. success_subtle, warning_subtle,error_subtle, info_subtle and neutral_subtle

<%= pb_rails("flex", props: {gap: "md", justify: "center", wrap: true}) do %>
  <%= pb_rails("background", props: { background_color: "success_subtle", padding: "xl" }) do %> <% end %>
  <br>
   <%= pb_rails("background", props: { background_color: "warning_subtle", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "error_subtle", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "info_subtle", padding: "xl" }) do %> <% end %>
  <br>
  <%= pb_rails("background", props: { background_color: "neutral_subtle", padding: "xl" }) do %> <% end %>
<%end%>

Category

Category colors can be passed into the background kit. Values category_1 to category_21 are accepted. List of all category and status colors can be viewed here.

<%= pb_rails("flex", props: {gap: "md", justify: "center", wrap: true}) do %>
  <%= pb_rails("background", props: { background_color: "category_1", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_2", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_3", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_4", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_5", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_6", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_7", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_8", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_9", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_10", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_11", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_12", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_13", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_14", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_15", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_16", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_17", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_18", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_19", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_20", padding: "xl" }) do %> <% end %>
  <%= pb_rails("background", props: { background_color: "category_21", padding: "xl" }) do %> <% end %>
<%end%>

Size

Background size can be passed into the background kit. Values auto, cover, and contain are accepted.

💡 Note: When using contain you might not want to have a repeating background as this will not always look pleasant. To prevent this, you may pass no-repeat to the backgroundRepeat prop.

 <%= pb_rails("background", props: { classname: "background-image", image_url: "https://images.unsplash.com/photo-1528459801416-a9e53bbf4e17?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1000&q=80", background_size: "auto", padding: "xl" }) %>
 <br/>
 <%= pb_rails("background", props: { classname: "background-image", image_url: "https://images.unsplash.com/photo-1528459801416-a9e53bbf4e17?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1000&q=80", background_size: "cover", padding: "xl" }) %>
 <br/>
 <%= pb_rails("background", props: { classname: "background-image", image_url: "https://images.unsplash.com/photo-1528459801416-a9e53bbf4e17?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1000&q=80", background_repeat: "no-repeat", background_size: "contain", padding: "xl" }) %>

Available Props

Props	Type	Values
align_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
align_items	enum \| responsive	start end center
border_radius	enum	none xs sm md lg xl rounded
cursor	enum	auto default none contextMenu help pointer progress wait cell
dark	boolean	true false
flex	enum \| responsive	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_direction	enum \| responsive	row column rowReverse columnReverse
flex_wrap	enum \| responsive	wrap nowrap wrapReverse
justify_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
line_height	enum	loosest looser loose normal tight tighter tightest
margin_right	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_top	array	none xxs xs sm md lg xl
margin_bottom	array	none xxs xs sm md lg xl
margin_x	array	none xxs xs sm md lg xl
margin_y	array	none xxs xs sm md lg xl
margin	array	none xxs xs sm md lg xl
width	string
min_width	string
max_width	string
gap	string \| responsive
column_gap	string \| responsive
row_gap	string \| responsive
number_spacing	enum	tabular
order	enum \| responsive	none first 1 2 3 4 5 6 7 8 9 10 11 12
overflow_x	enum	scroll visible hidden auto
overflow_y	enum	scroll visible hidden auto
overflow	enum	scroll visible hidden auto
padding_right	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_top	array	none xxs xs sm md lg xl
padding_bottom	array	none xxs xs sm md lg xl
padding_x	array	none xxs xs sm md lg xl
padding_y	array	none xxs xs sm md lg xl
padding	array	none xxs xs sm md lg xl
position	enum	relative absolute fixed sticky static
shadow	enum	none deep deeper deepest
text_align	enum \| responsive	start end left right center justify justifyAll matchParent
truncate	enum	none 1 2 3 4 5
vertical_align	enum \| responsive	baseline super top middle bottom sub text-top text-bottom
z_index	enum \| responsive	1 2 3 4 5 6 7 8 9 10 max
top	enum \| object	xxs xs sm md lg xl xxl
inset	boolean	true false
right	enum \| object	xxs xs sm md lg xl xxl
bottom	enum \| object	xxs xs sm md lg xl xxl
left	enum \| object	xxs xs sm md lg xl xxl
height	string
max_height	string
min_height	string
hover	object
group_hover	boolean	true false

Props	Type	Values	Default
alt	string
background_color	responsiveprop<backgroundcolors> \| backgroundcolors	gradient dark light white success warning error info neutral primary shadow category_1 category_2 category_3 category_4 category_5 category_6 category_7 category_8 category_9 category_10 category_11 category_12 category_13 category_14 category_15 category_16 category_17 category_18 category_19 category_20 category_21 success_secondary error_secondary info_secondary warning_secondary neutral_secondary primary_secondary text_lt_default text_lt_light text_lt_lighter text_dk_default text_dk_light text_dk_lighter card_light card_dark data_1 data_2 data_3 data_4 data_5 data_6 data_7 data_8 border_light border_dark success_subtle warning_subtle error_subtle info_subtle neutral_subtle	light
background_size	responsiveprop<backgroundsizes> \| backgroundsizes	contain cover auto	cover
background_position	responsiveprop<string> \| string
background_repeat	responsiveprop<backgroundrepeat> \| backgroundrepeat	repeat repeat-x repeat-y no-repeat space round initial inherit	initial
image_url	responsiveprop<string> \| string
image_overlay	enum	opacity_1 opacity_2 opacity_3 opacity_4 opacity_5 opacity_6 opacity_7 opacity_8 opacity_9 opacity_10
custom_color	string
tag	enum	h1 h2 h3 h4 h5 h6 p span div tr th td thead col	div
transition	enum	fade blur scale

Contribute to Playbook

When you start designing a new feature, you may come across a Design Token or Component that isn’t defined in Playbook. If so, you should open an issue or reach out to the team to make a contribution.

Contribute on GitHub

As the highest-rated residential remodeler in the nation, our international technology team builds a custom suite of products that continuously transform our business.

Power

Tech @ Power

Open Positions

About Power

Connect

Github

Connect Chat

Background

Background Kit Image

Available Props

align_content

align_items

border_radius

cursor

dark

flex

flex_direction

flex_wrap

justify_content

line_height

margin_right

margin_left

margin_top

margin_bottom

margin_x

margin_y

margin

width

min_width

max_width

gap

column_gap

row_gap

number_spacing

order

overflow_x

overflow_y

overflow

padding_right

padding_left

padding_top

padding_bottom

padding_x

padding_y

padding

position

shadow

text_align

truncate

vertical_align

z_index

top

inset

right

bottom

left

height

max_height

min_height

hover

group_hover

alt

background_color

background_size

background_position

background_repeat

image_url

image_overlay

custom_color

tag

transition

Contribute to Playbook

Power

Connect