Class: Primer::BreadcrumbComponent

Inherits:
Component
  • Object
show all
Includes:
ViewComponent::Slotable
Defined in:
app/components/primer/breadcrumb_component.rb

Overview

Use breadcrumbs to display page hierarchy within a section of the site. All of the items in the breadcrumb “trail” are links except for the final item, which is a plain string indicating the current page.

Defined Under Namespace

Classes: BreadcrumbItem

Constant Summary

Constants inherited from Component

Component::STATUSES

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Method Summary collapse

Methods inherited from Component

status

Methods included from ViewHelper

#primer

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(**system_arguments) ⇒ BreadcrumbComponent

Returns a new instance of BreadcrumbComponent.

Examples:

Basic

<%= render(Primer::BreadcrumbComponent.new) do |component| %>
  <% component.slot(:item, href: "/") do %>Home<% end %>
  <% component.slot(:item, href: "/about") do %>About<% end %>
  <% component.slot(:item, selected: true) do %>Team<% end %>
<% end %>

Parameters:

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



18
19
20
21
22
 
# File 'app/components/primer/breadcrumb_component.rb', line 18

def initialize(**system_arguments)
  @system_arguments = system_arguments
  @system_arguments[:tag] = :nav
  @system_arguments[:aria] = { label: "Breadcrumb" }
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'app/components/primer/breadcrumb_component.rb', line 24

def render?
  items.any?
end