Class: Primer::LabelComponent

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

Overview

Use ‘Label` to add contextual metadata to a design.

Constant Summary collapse

DEFAULT_TAG = 
:span
TAG_OPTIONS = 
[DEFAULT_TAG, :summary, :a, :div].freeze
DEFAULT_SCHEME = 
:default
SCHEME_MAPPINGS = 
{
  DEFAULT_SCHEME => "",
  :primary => "Label--primary",
  :secondary => "Label--secondary",
  :accent => "Label--accent",
  :success => "Label--success",
  :attention => "Label--attention",
  :danger => "Label--danger",
  :severe => "Label--severe",
  :done => "Label--done",
  :sponsors => "Label--sponsors",
  # deprecated
  :info => "Label--info",
  :warning => "Label--warning",
  :orange => "Label--orange",
  :purple => "Label--purple"
}.freeze
DEPRECATED_SCHEME_OPTIONS = 
[:info, :warning, :orange, :purple].freeze
SCHEME_OPTIONS = 
(SCHEME_MAPPINGS.keys - DEPRECATED_SCHEME_OPTIONS).freeze
VARIANT_MAPPINGS = 
{
  large: "Label--large",
  inline: "Label--inline"
}.freeze
VARIANT_OPTIONS = 
VARIANT_MAPPINGS.keys << nil

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(tag: DEFAULT_TAG, scheme: DEFAULT_SCHEME, variant: nil, **system_arguments) ⇒ LabelComponent

Returns a new instance of LabelComponent.

Examples:

Schemes

<%= render(Primer::LabelComponent.new) { "Default" } %>
<%= render(Primer::LabelComponent.new(scheme: :primary)) { "Primary" } %>
<%= render(Primer::LabelComponent.new(scheme: :secondary)) { "Secondary" } %>
<%= render(Primer::LabelComponent.new(scheme: :accent)) { "Accent" } %>
<%= render(Primer::LabelComponent.new(scheme: :success)) { "Success" } %>
<%= render(Primer::LabelComponent.new(scheme: :attention)) { "Attention" } %>
<%= render(Primer::LabelComponent.new(scheme: :danger)) { "Danger" } %>
<%= render(Primer::LabelComponent.new(scheme: :severe)) { "Severe" } %>
<%= render(Primer::LabelComponent.new(scheme: :done)) { "Done" } %>
<%= render(Primer::LabelComponent.new(scheme: :sponsors)) { "Sponsors" } %>

Variants

<%= render(Primer::LabelComponent.new) { "Default" } %>
<%= render(Primer::LabelComponent.new(variant: :large)) { "Large" } %>

Parameters:

  • tag (Symbol) (defaults to: DEFAULT_TAG) —

    <%= one_of(Primer::LabelComponent::TAG_OPTIONS) %>

  • scheme (Symbol) (defaults to: DEFAULT_SCHEME) —

    <%= one_of(Primer::LabelComponent::SCHEME_MAPPINGS.keys) %>

  • variant (Symbol) (defaults to: nil) —

    <%= one_of(Primer::LabelComponent::VARIANT_OPTIONS) %>

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



61
62
63
64
65
66
67
68
69
70
 
# File 'app/components/primer/label_component.rb', line 61

def initialize(tag: DEFAULT_TAG, scheme: DEFAULT_SCHEME, variant: nil, **system_arguments)
  @system_arguments = system_arguments
  @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)
  @system_arguments[:classes] = class_names(
    "Label",
    system_arguments[:classes],
    SCHEME_MAPPINGS[fetch_or_fallback(SCHEME_OPTIONS, scheme, deprecated_values: DEPRECATED_SCHEME_OPTIONS)],
    VARIANT_MAPPINGS[fetch_or_fallback(VARIANT_OPTIONS, variant)]
  )
end

Instance Method Details

#call ⇒ Object 



72
73
74
 
# File 'app/components/primer/label_component.rb', line 72

def call
  render(Primer::BaseComponent.new(**@system_arguments)) { content }
end