Class: Primer::Alpha::TreeView::Visual

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/alpha/tree_view/visual.rb

Overview

A ‘TreeView` visual, either leading or trailing.

This component is part of the <%= link_to_component(Primer::Alpha::TreeView) %> component and should not be used directly.

Constant Summary

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 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(id:, visual:, label: nil) ⇒ Visual

Returns a new instance of Visual.

Parameters:

  • id (String) —

    This visual’s HTML ID.

  • visual (ViewComponent::Base) —

    A renderable component like an instance of <%= link_to_component(Primer::Beta::Octicon) %> to render as the visual.

  • label (String) (defaults to: nil) —

    Text describing this visual that will be visible only to screen readers.



14
15
16
17
18
 
# File 'app/components/primer/alpha/tree_view/visual.rb', line 14

def initialize(id:, visual:, label: nil)
  @id = id
  @visual = visual
  @label = label
end

Instance Method Details

#render_in(_view_context, &block) ⇒ Object 



20
21
22
23
 
# File 'app/components/primer/alpha/tree_view/visual.rb', line 20

def render_in(_view_context, &block)
  block&.call(@visual)
  super
end