Class: Primer::OpenProject::PageHeader::Title

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/open_project/page_header/title.rb

Overview

A Helper class to create a Title inside the PageHeader title slot It should not be used standalone

Constant Summary collapse

HEADING_TAG_OPTIONS = 
[:h1, :h2, :h3, :h4, :h5, :h6].freeze
HEADING_TAG_FALLBACK = 
:h1

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

Constants included from AttributesHelper

AttributesHelper::PLURAL_ARIA_ATTRIBUTES, AttributesHelper::PLURAL_DATA_ATTRIBUTES

Instance Method Summary collapse

Methods inherited from Component

deprecated?, generate_id

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

Methods included from AttributesHelper

#aria, #data, #extract_data, #merge_aria, #merge_data, #merge_prefixed_attribute_hashes

Methods included from ExperimentalSlotHelpers

included

Methods included from ExperimentalRenderHelpers

included

Constructor Details

#initialize(tag: HEADING_TAG_FALLBACK, state: Primer::OpenProject::PageHeader::STATE_DEFAULT, **system_arguments) ⇒ Title

Returns a new instance of Title.

Parameters:

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



48
49
50
51
52
53
 
# File 'app/components/primer/open_project/page_header/title.rb', line 48

def initialize(tag: HEADING_TAG_FALLBACK, state: Primer::OpenProject::PageHeader::STATE_DEFAULT, **system_arguments)
  @system_arguments = system_arguments
  @system_arguments[:tag] = fetch_or_fallback(HEADING_TAG_OPTIONS, tag, HEADING_TAG_FALLBACK)

  @state = state
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (ArgumentError) 


55
56
57
58
59
 
# File 'app/components/primer/open_project/page_header/title.rb', line 55

def render?
  raise ArgumentError, "Please define form paramaters for the editable title" if !show_state? && !editable_form?

  content? && (show_state? || editable_form?)
end