blacklight 7.16.0 → 7.17.0

data/app/components/blacklight/document_metadata_component.html.erb

@@ -1,5 +1,5 @@
 <dl class="document-metadata dl-invert row">
-  <% @fields.each do |field| -%>
-    <%= @view_context.render(field_component(field).new(field: field, show: @show)) %>
+  <% fields.each do |field| -%>
+    <%= field %>
   <% end -%>
 </dl>

data/app/components/blacklight/document_metadata_component.rb

@@ -2,16 +2,27 @@
 
 module Blacklight
   class DocumentMetadataComponent < ::ViewComponent::Base
+    renders_many :fields, (lambda do |component: nil, **kwargs|
+      (component || Blacklight::MetadataFieldComponent).new(**kwargs)
+    end)
     with_collection_parameter :fields
 
     # @param fields [Enumerable<Blacklight::FieldPresenter>] Document field presenters
-    def initialize(fields:, show: false)
+    def initialize(fields: [], show: false)
       @fields = fields
       @show = show
     end
 
+    def before_render
+      return unless fields
+
+      @fields.each do |field|
+        field(component: field_component(field), field: field, show: @show)
+      end
+    end
+
     def render?
-      @fields.any?
+      fields.present?
     end
 
     def field_component(field)

data/app/components/blacklight/document_title_component.html.erb

@@ -0,0 +1,17 @@
+<header class="documentHeader row">
+  <%= content_tag @as, class: @classes do %>
+    <% before_title.each do |t| %>
+      <%= t %>
+    <% end %>
+
+    <%= counter -%><%= title -%>
+
+    <% after_title.each do |t| %>
+      <%= t %>
+    <% end %>
+  <% end %>
+
+  <% actions.each do |action| %>
+    <%= action %>
+  <% end %>
+</header>

data/app/components/blacklight/document_title_component.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class DocumentTitleComponent < ::ViewComponent::Base
+    renders_many :before_title
+    renders_many :after_title
+    renders_many :actions
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(title = nil, document: nil, presenter: nil, as: :h3, counter: nil, classes: 'index_title document-title-heading col', link_to_document: true, document_component: nil)
+      raise ArgumentError, 'missing keyword: :document or :presenter' if presenter.nil? && document.nil?
+
+      @title = title
+      @document = document
+      @presenter = presenter
+      @as = as || :h3
+      @counter = counter
+      @classes = classes
+      @link_to_document = link_to_document
+      @document_component = document_component
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    # Content for the document title area; should be an inline element
+    def title
+      if @link_to_document
+        @view_context.link_to_document presenter.document, @title.presence || content.presence, counter: @counter, itemprop: 'name'
+      else
+        content_tag('span', @title.presence || content.presence || presenter.heading, itemprop: 'name')
+      end
+    end
+
+    # Content for the document actions area
+    def actions
+      if block_given?
+        @has_actions_slot = true
+        return super
+      end
+
+      (@has_actions_slot && get_slot(:actions)) ||
+        ([@document_component&.actions] if @document_component&.actions.present?) ||
+        [@view_context.render_index_doc_actions(presenter.document, wrapping_class: 'index-document-functions col-sm-3 col-lg-2')]
+    end
+
+    def counter
+      return unless @counter
+
+      content_tag :span, class: 'document-counter' do
+        t('blacklight.search.documents.counter', counter: @counter)
+      end
+    end
+
+    private
+
+    def presenter
+      @presenter ||= @view_context.document_presenter(@document)
+    end
+  end
+end

data/app/components/blacklight/facet_field_checkboxes_component.html.erb

@@ -1,9 +1,9 @@
 <%= render(@layout.new(facet_field: @facet_field)) do |component| %>
-  <% component.with(:label) do %>
+  <% component.label do %>
     <%= @facet_field.label %>
   <% end %>
 
-  <% component.with(:body) do %>
+  <% component.body do %>
     <ul class="facet-values list-unstyled blacklight-facet-checkboxes">
       <% presenters.each_with_index do |presenter, idx| -%>
         <li>

data/app/components/blacklight/facet_field_component.rb

@@ -2,7 +2,10 @@
 
 module Blacklight
   class FacetFieldComponent < ::ViewComponent::Base
-    with_content_areas :label, :body
+    include Blacklight::ContentAreasShim
+
+    renders_one :label
+    renders_one :body
 
     def initialize(facet_field:)
       @facet_field = facet_field

data/app/components/blacklight/facet_field_list_component.html.erb

@@ -1,8 +1,8 @@
 <%= render(@layout.new(facet_field: @facet_field)) do |component| %>
-  <% component.with(:label) do %>
+  <% component.label do %>
     <%= @facet_field.label %>
   <% end %>
-  <% component.with(:body) do %>
+  <% component.body do %>
     <%= @view_context.render(Blacklight::FacetFieldInclusiveConstraintComponent.new(facet_field: @facet_field)) %>
     <ul class="facet-values list-unstyled">
       <%= render_facet_limit_list @facet_field.paginator, @facet_field.key %>

data/app/components/blacklight/facet_field_no_layout_component.rb

@@ -2,7 +2,10 @@
 
 module Blacklight
   class FacetFieldNoLayoutComponent < ::ViewComponent::Base
-    with_content_areas :label, :body
+    include Blacklight::ContentAreasShim
+
+    renders_one :label
+    renders_one :body
 
     def initialize(**); end
 

data/app/components/blacklight/metadata_field_component.html.erb

@@ -1,8 +1,8 @@
 <%= render(@layout.new(field: @field)) do |component| %>
-  <% component.with(:label) do %>
+  <% component.label do %>
     <%= label %>
   <% end %>
-  <% component.with(:value) do %>
+  <% component.value do %>
     <%= @field.render %>
   <% end %>
 <% end %>

data/app/components/blacklight/metadata_field_layout_component.html.erb

@@ -1,2 +1,4 @@
 <dt class="blacklight-<%= @key %> <%= @label_class %>"><%= label %></dt>
-<dd class="blacklight-<%= @key %> <%= @value_class %>"><%= value %></dd>
+<% values.each do |v| %>
+  <%= v %>
+<% end %>

data/app/components/blacklight/metadata_field_layout_component.rb

@@ -2,8 +2,17 @@
 
 module Blacklight
   class MetadataFieldLayoutComponent < ::ViewComponent::Base
+    include Blacklight::ContentAreasShim
+
     with_collection_parameter :field
-    with_content_areas :label, :value
+    renders_one :label
+    renders_many :values, (lambda do |value: nil, &block|
+      if block
+        content_tag :dd, class: "#{@value_class} blacklight-#{@key}", &block
+      else
+        content_tag :dd, value, class: "#{@value_class} blacklight-#{@key}"
+      end
+    end)
 
     # @param field [Blacklight::FieldPresenter]
     def initialize(field:, label_class: 'col-md-3', value_class: 'col-md-9')
@@ -12,5 +21,21 @@ module Blacklight
       @label_class = label_class
       @value_class = value_class
     end
+
+    def value(*args, **kwargs, &block)
+      return set_slot(:values, *args, **kwargs, &block) if block_given?
+
+      Deprecation.warn('The `value` content area is deprecated; render from the values slot instead')
+
+      values.first
+    end
+
+    def with(slot_name, *args, **kwargs, &block)
+      if slot_name == :value
+        super(:values, *args, **kwargs, &block)
+      else
+        super
+      end
+    end
   end
 end

data/app/components/blacklight/response/view_type_button_component.html.erb

@@ -0,0 +1,4 @@
+<%= link_to url, title: label, class: "#{Array(@classes).join(' ')} view-type-#{ @key.to_s.parameterize } #{"active" if selected?}" do %>
+  <%= icon %>
+  <span class="caption"><%= label %></span>
+<% end %>

data/app/components/blacklight/response/view_type_button_component.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Response
+    # Render spellcheck results for a search query
+    class ViewTypeButtonComponent < ViewComponent::Base
+      with_collection_parameter :view
+      # @param [Blacklight::Configuration::View] view
+      def initialize(view:, key: nil, selected: false, search_state: nil, classes: 'btn btn-outline-secondary btn-icon')
+        @view = view
+        @key = key || view.key
+        @selected = selected
+        @classes = classes
+        @search_state = search_state
+      end
+
+      def icon
+        @view_context.render_view_type_group_icon(@view)
+      end
+
+      def label
+        Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
+          @view_context.view_label(@view)
+        end
+      end
+
+      def url
+        @view_context.url_for(@search_state.to_h.merge(view: @key))
+      end
+
+      def selected?
+        @selected
+      end
+    end
+  end
+end

data/app/components/blacklight/response/view_type_component.html.erb

@@ -1,11 +1,8 @@
 <div class="view-type">
   <span class="sr-only"><%= t('blacklight.search.view_title') %></span>
   <div class="view-type-group btn-group">
-    <% @views.each do |view, config| %>
-      <%= link_to url(view), title: label(view), class: "btn btn-outline-secondary btn-icon view-type-#{ view.to_s.parameterize } #{"active" if @selected == view}" do %>
-        <%= icon(view) %>
-        <span class="caption"><%= label(view) %></span>
-      <% end %>
+    <% views.each do |view| %>
+      <%= view %>
     <% end %>
   </div>
 </div>

data/app/components/blacklight/response/view_type_component.rb

@@ -4,6 +4,8 @@ module Blacklight
   module Response
     # Render spellcheck results for a search query
     class ViewTypeComponent < ViewComponent::Base
+      renders_many :views, 'Blacklight::Response::ViewTypeButtonComponent'
+
       # @param [Blacklight::Response] response
       def initialize(response:, views: {}, search_state:, selected: nil)
         @response = response
@@ -12,25 +14,19 @@ module Blacklight
         @selected = selected
       end
 
-      def render?
-        Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
-          @view_context.has_alternative_views?
-        end
-      end
+      def before_render
+        return if views.any?
 
-      def icon(view)
-        @view_context.render_view_type_group_icon(view)
+        @views.each do |key, config|
+          view(key: key, view: config, selected: @selected == key, search_state: @search_state)
+        end
       end
 
-      def label(view)
+      def render?
         Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
-          @view_context.view_label(view)
+          @view_context.has_alternative_views?
         end
       end
-
-      def url(view)
-        @view_context.url_for(@search_state.to_h.merge(view: view))
-      end
     end
   end
 end

data/app/components/blacklight/search_bar_component.rb

@@ -2,7 +2,10 @@
 
 module Blacklight
   class SearchBarComponent < ::ViewComponent::Base
-    with_content_areas :append, :prepend
+    include Blacklight::ContentAreasShim
+
+    renders_one :append
+    renders_one :prepend
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(

data/app/components/blacklight/system/dropdown_component.html.erb

@@ -1,12 +1,9 @@
 <%= content_tag :div, id: @id, class: @classes.join(' ') do %>
-  <button type="button" class="btn btn-outline-secondary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
-    <%= t(:button_label_html, default: :label_html, scope: "blacklight.search.#{@param}", @interpolation => label_for_value(@selected)) %> <span class="caret"></span>
-  </button>
+  <%= button %>
 
   <div class="dropdown-menu" role="menu">
-    <%- @choices.each do |option| %>
-      <% text, value = option_text_and_value(option) %>
-      <%= link_to(text, @view_context.url_for(@search_state.params_for_search(@param => value)), class: 'dropdown-item', role: 'menuitem') %>
-    <%- end -%>
+    <% options.each do |option| %>
+      <%= option %>
+    <% end %>
   </div>
 <% end %>

data/app/components/blacklight/system/dropdown_component.rb

@@ -3,6 +3,15 @@
 module Blacklight
   module System
     class DropdownComponent < ViewComponent::Base
+      renders_one :button, (lambda do |classes:, label:|
+        button_tag class: classes, aria: { expanded: false }, data: { toggle: 'dropdown' } do
+          safe_join([label, content_tag(:span, '', class: 'caret')])
+        end
+      end)
+      renders_many :options, (lambda do |text:, url:, selected: false|
+        link_to(text, url, class: "dropdown-item #{'active' if selected}", role: 'menuitem', aria: { current: ('page' if selected) })
+      end)
+
       # rubocop:disable Metrics/ParameterLists
       def initialize(param:, choices:, search_state:, id: nil, classes: [], default: nil, selected: nil, interpolation: :field)
         @param = param
@@ -15,6 +24,21 @@ module Blacklight
       end
       # rubocop:enable Metrics/ParameterLists
 
+      def button_label
+        t(:button_label_html, default: :label_html, scope: "blacklight.search.#{@param}", @interpolation => label_for_value(@selected))
+      end
+
+      def before_render
+        button(classes: 'btn btn-outline-secondary dropdown-toggle', label: button_label) unless button
+
+        return if options.any?
+
+        options(@choices.map do |option|
+          text, value = option_text_and_value(option)
+          { text: text, url: @view_context.url_for(@search_state.params_for_search(@param => value)), selected: @selected == value }
+        end)
+      end
+
       def render?
         @choices.many?
       end

data/app/components/blacklight/system/flash_message_component.html.erb

@@ -1,4 +1,4 @@
 <div class="alert <%= @classes %>">
-  <%= @message %>
+  <%= message %>
   <a class="close" data-dismiss="alert" href="#">&times;</a>
 </div>

data/app/components/blacklight/system/flash_message_component.rb

@@ -3,13 +3,19 @@
 module Blacklight
   module System
     class FlashMessageComponent < ViewComponent::Base
+      renders_one :message
+
       with_collection_parameter :message
 
-      def initialize(message:, type:)
+      def initialize(message: nil, type:)
         @message = message
         @classes = alert_class(type)
       end
 
+      def before_render
+        message { @message } if @message
+      end
+
       def alert_class(type)
         case type.to_s
         when 'success' then "alert-success"

data/app/components/blacklight/system/modal_component.rb

@@ -3,7 +3,13 @@
 module Blacklight
   module System
     class ModalComponent < ViewComponent::Base
-      with_content_areas :prefix, :header, :title, :body, :footer
+      include Blacklight::ContentAreasShim
+
+      renders_one :prefix
+      renders_one :header
+      renders_one :title
+      renders_one :body
+      renders_one :footer
     end
   end
 end