Class: Blacklight::MetadataFieldComponent

Inherits:

Component

• Object
• ViewComponent::Base
• Component
• Blacklight::MetadataFieldComponent

Defined in:

app/components/blacklight/metadata_field_component.rb

Constant Summary

Constants inherited from Component

Component::EXCLUDE_VARIABLES

Instance Method Summary

• #initialize(field:, layout: nil, show: false) ⇒ MetadataFieldComponent constructor

  A new instance of MetadataFieldComponent.

• #label ⇒ Object
• #render? ⇒ Boolean

Methods inherited from Component

compiler, config, #inspect

Constructor Details

#initialize(field:, layout: nil, show: false) ⇒ MetadataFieldComponent

Returns a new instance of MetadataFieldComponent.

Parameters:

• field (Blacklight::FieldPresenter)
• layout (Blacklight::MetadataFieldLayoutComponent) (defaults to: nil) —

  alternate layout component to use

• show (Boolean) (defaults to: false) —

  are we showing only a single document (vs a list of search results); used for backwards-compatibility

# File 'app/components/blacklight/metadata_field_component.rb', line 10

def initialize(field:, layout: nil, show: false)
  @field = field
  @layout = layout || Blacklight::MetadataFieldLayoutComponent
  @show = show
end

Instance Method Details

#label ⇒ Object

# File 'app/components/blacklight/metadata_field_component.rb', line 17

def label
  Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
    if @show
      helpers.render_document_show_field_label @field.document, label: @field.label('show'), field: @field.key
    else
      helpers.render_index_field_label @field.document, label: @field.label, field: @field.key
    end
  end
end

#render? ⇒ Boolean

Returns:

• (Boolean)

# File 'app/components/blacklight/metadata_field_component.rb', line 27

def render?
  @field.render_field?
end