Class: Primer::ProgressBarComponent

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

Overview

Use ‘ProgressBar` to visualize task completion.

Constant Summary collapse

SIZE_DEFAULT = 
:default
SIZE_MAPPINGS = 
{
  SIZE_DEFAULT => "",
  :small => "Progress--small",
  :large => "Progress--large"
}.freeze
SIZE_OPTIONS = 
SIZE_MAPPINGS.keys

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(size: SIZE_DEFAULT, **system_arguments) ⇒ ProgressBarComponent

Returns a new instance of ProgressBarComponent.

Examples:

Default

<%= render(Primer::ProgressBarComponent.new) do |component| %>
  <% component.item(percentage: 25) %>
<% end %>

Small

<%= render(Primer::ProgressBarComponent.new(size: :small)) do |component| %>
  <% component.item(bg: :accent_emphasis, percentage: 50) %>
<% end %>

Large

<%= render(Primer::ProgressBarComponent.new(size: :large)) do |component| %>
  <% component.item(bg: :danger_emphasis, percentage: 75) %>
<% end %>

Multiple items

<%= render(Primer::ProgressBarComponent.new) do |component| %>
  <% component.item(percentage: 10) %>
  <% component.item(bg: :accent_emphasis, percentage: 20) %>
  <% component.item(bg: :danger_emphasis, percentage: 30) %>
<% end %>

Parameters:

  • size (Symbol) (defaults to: SIZE_DEFAULT) —

    <%= one_of(Primer::ProgressBarComponent::SIZE_OPTIONS) %> Increases height.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



56
57
58
59
60
61
62
63
64
 
# File 'app/components/primer/progress_bar_component.rb', line 56

def initialize(size: SIZE_DEFAULT, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:classes] = class_names(
    @system_arguments[:classes],
    "Progress",
    SIZE_MAPPINGS[fetch_or_fallback(SIZE_OPTIONS, size, SIZE_DEFAULT)]
  )
  @system_arguments[:tag] = :span
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'app/components/primer/progress_bar_component.rb', line 66

def render?
  items.any?
end