Class: Blacklight::Configuration::ViewConfig

Inherits:

OpenStructWithHashAccess

• Object
• OpenStruct
• OpenStructWithHashAccess
• Blacklight::Configuration::ViewConfig

Defined in:

lib/blacklight/configuration/view_config.rb

Direct Known Subclasses

Index, Show

Defined Under Namespace

Classes: Index, Show

Instance Attribute Summary

• #constraints_component ⇒ Class

  Component class used to render the constraints.

• #display_type_field ⇒ String, Symbol

  Solr field to use to render format-specific partials.

• #document_actions ⇒ NestedOpenStructWithHashAccess{Symbol => Blacklight::Configuration::ToolConfig}

  ‘tools’ to render for each document.

• #document_component ⇒ Class

  Component class used to render a document; defaults to Blacklight::DocumentComponent.

• #document_presenter_class ⇒ Class

  Document presenter class used by helpers and views.

• #facet_group_component ⇒ Class

  Component class used to render a facet group.

• #icon ⇒ String, ...

  Icon file to use in the view picker.

• #partials ⇒ Array<String>

  Partials to render for each document(see #render_document_partials).

• #search_bar_component ⇒ Class

  Component class used to render the search bar.

• #search_header_component ⇒ Class

  Component class used to render the header above the documents.

• #template ⇒ String

  Partial to render around the documents.

• #title_field ⇒ String, Symbol

  Solr field to use to render a document title.

Instance Method Summary

• #display_label(**options) ⇒ Object

Methods inherited from OpenStructWithHashAccess

#deep_dup, #deep_transform_values, #merge, #merge!, #reverse_merge, #select, #sort_by, #sort_by!, #to_h, #try

Instance Attribute Details

#constraints_component ⇒ Class

Returns component class used to render the constraints.

Returns:

• (Class) —

  component class used to render the constraints

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#display_type_field ⇒ String, Symbol

Returns solr field to use to render format-specific partials.

Returns:

• (String, Symbol) —

  solr field to use to render format-specific partials

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#document_actions ⇒ NestedOpenStructWithHashAccess{Symbol => Blacklight::Configuration::ToolConfig}

Returns ‘tools’ to render for each document.

Returns:

• (NestedOpenStructWithHashAccess{Symbol => Blacklight::Configuration::ToolConfig}) —

  ‘tools’ to render for each document

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#document_component ⇒ Class

Returns component class used to render a document; defaults to Blacklight::DocumentComponent.

Returns:

• (Class) —

  component class used to render a document; defaults to Blacklight::DocumentComponent

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#document_presenter_class ⇒ Class

Returns document presenter class used by helpers and views.

Returns:

• (Class) —

  document presenter class used by helpers and views

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#facet_group_component ⇒ Class

Returns component class used to render a facet group.

Returns:

• (Class) —

  component class used to render a facet group

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#icon ⇒ String, ...

Returns icon file to use in the view picker.

Returns:

• (String, Symbol, Blacklight::Icons::IconComponent) —

  icon file to use in the view picker

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#partials ⇒ Array<String>

Returns partials to render for each document(see #render_document_partials).

Returns:

• (Array<String>) —

  partials to render for each document(see #render_document_partials)

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#search_bar_component ⇒ Class

Returns component class used to render the search bar.

Returns:

• (Class) —

  component class used to render the search bar

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#search_header_component ⇒ Class

Returns component class used to render the header above the documents.

Returns:

• (Class) —

  component class used to render the header above the documents

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#template ⇒ String

Returns partial to render around the documents.

Returns:

• (String) —

  partial to render around the documents

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

#title_field ⇒ String, Symbol

Returns solr field to use to render a document title.

Returns:

• (String, Symbol) —

  solr field to use to render a document title

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end

Instance Method Details

#display_label(**options) ⇒ Object

# File 'lib/blacklight/configuration/view_config.rb', line 29

def display_label(**options)
  I18n.t(
    :"blacklight.search.view_title.#{key}",
    default: [
      :"blacklight.search.view.#{key}",
      label,
      title,
      key.to_s.humanize
    ],
    **options
  )
end