Class: Primer::Alpha::TabNav

Inherits:
Component
  • Object
show all
Includes:
TabNavHelper, TabbedComponentHelper
Defined in:
app/components/primer/alpha/tab_nav.rb

Overview

Use ‘TabNav` to style navigation with a tab-based selected state, typically used for navigation placed at the top of the page. For panel navigation, use <%= link_to_component(Primer::Alpha::TabPanels) %> instead.

Constant Summary collapse

BODY_TAG_DEFAULT = 
:ul
TAG_DEFAULT = 
:nav
TAG_OPTIONS = 
[TAG_DEFAULT, :div].freeze

Constants included from TabNavHelper

TabNavHelper::EXTRA_ALIGN_DEFAULT, TabNavHelper::EXTRA_ALIGN_OPTIONS

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 Primer::AttributesHelper

Primer::AttributesHelper::PLURAL_ARIA_ATTRIBUTES, Primer::AttributesHelper::PLURAL_DATA_ATTRIBUTES

Instance Method Summary collapse

Methods included from TabNavHelper

#tab_nav_body_classes, #tab_nav_classes, #tab_nav_tab_classes

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 Primer::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(label:, tag: TAG_DEFAULT, body_arguments: {}, **system_arguments) ⇒ TabNav

Returns a new instance of TabNav.

Parameters:

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

    <%= one_of(Primer::Alpha::TabNav::TAG_OPTIONS) %>

  • label (String) —

    Sets an ‘aria-label` that helps assistive technology users understand the purpose of the links, and distinguish it from similar elements.

  • body_arguments (Hash) (defaults to: {}) —

    <%= link_to_system_arguments_docs %> for the body wrapper.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'app/components/primer/alpha/tab_nav.rb', line 51

def initialize(label:, tag: TAG_DEFAULT, body_arguments: {}, **system_arguments)
  @align = EXTRA_ALIGN_DEFAULT
  @system_arguments = system_arguments
  @body_arguments = body_arguments

  @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, TAG_DEFAULT)
  @system_arguments[:classes] = tab_nav_classes(system_arguments[:classes])

  @body_arguments[:tag] = BODY_TAG_DEFAULT
  @body_arguments[:classes] = tab_nav_body_classes(body_arguments[:classes])

  aria_label_for_page_nav(label)
end

Instance Method Details

#before_render ⇒ Object 



65
66
67
68
69
70
 
# File 'app/components/primer/alpha/tab_nav.rb', line 65

def before_render
  # Eagerly evaluate content to avoid https://github.com/primer/view_components/issues/1790
  content

  super
end