Class: Primer::BorderBoxComponent

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/border_box_component.rb

Overview

‘BorderBox` is a Box component with a border.

Constant Summary collapse

DEFAULT_PADDING = 
:default
PADDING_MAPPINGS = 
{
  DEFAULT_PADDING => "",
  :condensed => "Box--condensed",
  :spacious => "Box--spacious"
}.freeze
PADDING_SUGGESTION = 
"Perhaps you could consider using :padding options of #{PADDING_MAPPINGS.keys.to_sentence}?"
DEFAULT_ROW_SCHEME = 
:default
ROW_SCHEME_MAPPINGS = 
{
  DEFAULT_ROW_SCHEME => "",
  :neutral => "Box-row--gray",
  :info => "Box-row--blue",
  :warning => "Box-row--yellow"
}.freeze

Constants inherited from Component

Component::INVALID_ARIA_LABEL_TAGS

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Method Summary collapse

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(padding: DEFAULT_PADDING, **system_arguments) ⇒ BorderBoxComponent

Returns a new instance of BorderBoxComponent.

Examples:

Header with title, body, rows, and footer

<%= render(Primer::BorderBoxComponent.new) do |component| %>
  <% component.header do |h| %>
    <% h.title(tag: :h2) do %>
      Header
    <% end %>
  <% end %>
  <% component.body do %>
    Body
  <% end %>
  <% component.row do %>
    <% if true %>
      Row one
    <% end %>
  <% end %>
  <% component.row do %>
    Row two
  <% end %>
  <% component.footer do %>
    Footer
  <% end %>
<% end %>

Padding density

<%= render(Primer::BorderBoxComponent.new(padding: :condensed)) do |component| %>
  <% component.header do %>
    Header
  <% end %>
  <% component.body do %>
    Body
  <% end %>
  <% component.row do %>
    Row two
  <% end %>
  <% component.footer do %>
    Footer
  <% end %>
<% end %>

Row colors

<%= render(Primer::BorderBoxComponent.new) do |component| %>
  <% component.row do %>
    Default
  <% end %>
  <% component.row(scheme: :neutral) do %>
    Neutral
  <% end %>
  <% component.row(scheme: :info) do %>
    Info
  <% end %>
  <% component.row(scheme: :warning) do %>
    Warning
  <% end %>
<% end %>

Parameters:

  • padding (Symbol) (defaults to: DEFAULT_PADDING) —

    <%= one_of(Primer::BorderBoxComponent::PADDING_MAPPINGS.keys) %>

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



129
130
131
132
133
134
135
136
137
138
139
 
# File 'app/components/primer/border_box_component.rb', line 129

def initialize(padding: DEFAULT_PADDING, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :div
  @system_arguments[:classes] = class_names(
    "Box",
    PADDING_MAPPINGS[fetch_or_fallback(PADDING_MAPPINGS.keys, padding, DEFAULT_PADDING)],
    system_arguments[:classes]
  )

  @system_arguments[:system_arguments_denylist] = { [:p, :pt, :pb, :pr, :pl] => PADDING_SUGGESTION }
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'app/components/primer/border_box_component.rb', line 141

def render?
  rows.any? || header.present? || body.present? || footer.present?
end