blacklight 7.17.2 → 7.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cacc94e8533f909ef9e137dca8f86809489626624507e04051c0923f1471d21c
-  data.tar.gz: 83c86c5a1789266ca17d1ad446320f4634acf0c6a95c456dffd7cbd1653bb4e1
+  metadata.gz: 9f48da02e969e0c163d09760d711066ce9c0b4d5078636c8f50e19699ec58e8e
+  data.tar.gz: 77da2b86854e93f08a79ba9e28c86c7c91116b9f6934229eb6936cc6872bfdc6
 SHA512:
-  metadata.gz: 07aa3c78687f57145209b5834d4f3512ced41f80b34e4b2dd6d72271d229922041de56f015271ba58ad62dc9c21fbd7f7f9cc0eb284080036e6e6092de73a48e
-  data.tar.gz: 7cd2dd6b95c77c07d06b3c1c58e4e5d7dda5fe415a6dfd61498a8e2fc83778685b0a86d08a354fbc8fc60f69dbe842f1a45a9fea5da133978d75888ee9506026
+  metadata.gz: a42155551ab05fa25e433a7aad6e40078ce7cbc2918de03f6ede94aef53ade03b4b16f4411a915b737b1233a631d9cb2baddc9d560aa70b67df237776c01e7f6
+  data.tar.gz: 6430192899c4db45277e988217aecc04e954d856645941773176e36ecefd3ddda3c2a9988caffb7bde50f8aa76702a10cd00da67216f17c6fb49a2802a678dfe

data/VERSION

@@ -1 +1 @@
-7.17.2
+7.19.2

data/app/assets/javascripts/blacklight/blacklight.js

@@ -352,7 +352,7 @@ Blacklight.modal.modalCloseSelector = '[data-blacklight-modal~=close]'; // Calle
 
 Blacklight.modal.onFailure = function (jqXHR, textStatus, errorThrown) {
   console.error('Server error:', this.url, jqXHR.status, errorThrown);
-  var contents = '<div class="modal-header">' + '<div class="modal-title">There was a problem with your request.</div>' + '<button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="Close">' + '  <span aria-hidden="true">&times;</span>' + '</button></div>' + ' <div class="modal-body"><p>Expected a successful response from the server, but got an error</p>' + '<pre>' + this.type + ' ' + this.url + "\n" + jqXHR.status + ': ' + errorThrown + '</pre></div>';
+  var contents = '<div class="modal-header">' + '<div class="modal-title">There was a problem with your request.</div>' + '<button type="button" class="blacklight-modal-close btn-close close" data-dismiss="modal" aria-label="Close">' + '  <span aria-hidden="true">&times;</span>' + '</button></div>' + ' <div class="modal-body"><p>Expected a successful response from the server, but got an error</p>' + '<pre>' + this.type + ' ' + this.url + "\n" + jqXHR.status + ': ' + errorThrown + '</pre></div>';
   $(Blacklight.modal.modalSelector).find('.modal-content').html(contents);
   $(Blacklight.modal.modalSelector).modal('show');
 };
@@ -495,4 +495,3 @@ Blacklight.handleSearchContextMethod = function (event) {
 Blacklight.onLoad(function () {
   Blacklight.doSearchContextBehavior();
 });
-

data/app/assets/stylesheets/blacklight/_balanced_list.scss

@@ -2,11 +2,11 @@
   dt {
     font-weight: normal;
     color: $field_name_color;
-    @media (max-width: breakpoint-max(sm)) {
+    @media (max-width: breakpoint-min(md)) {
       text-align: left;
     }
 
-    @media (min-width: breakpoint-max(sm)) {
+    @media (min-width: breakpoint-min(md)) {
       text-align: right;
     }
   }

data/app/assets/stylesheets/blacklight/_bootstrap_overrides.scss

@@ -5,7 +5,7 @@
 // Facet field headings and buttons
 .facet-field-heading {
   border-bottom: 0;
-  
+
   button {
     font-weight: $headings-font-weight;
 

data/app/assets/stylesheets/blacklight/_constraints.scss

@@ -8,8 +8,8 @@
     text-overflow: ellipsis;
     overflow: hidden;
 
-    @media (max-width: breakpoint-max(xs)) {
-      max-width: breakpoint-max(xs) / 2;
+    @media (max-width: breakpoint-min(sm)) {
+      max-width: breakpoint-min(sm) / 2;
     }
 
     @media (min-width: breakpoint-min(sm)) and (max-width: breakpoint-max(sm)) {

data/app/assets/stylesheets/blacklight/_controls.scss

@@ -34,7 +34,8 @@
   display: inline-block;
 
   .caption {
-    @extend .sr-only;
+    @extend .sr-only !optional;
+    @extend .visually-hidden !optional;
   }
 }
 

data/app/assets/stylesheets/blacklight/_facets.scss

@@ -3,7 +3,8 @@
     border-color: $navbar-light-toggler-border-color;
     color: $navbar-light-active-color;
 
-    @include hover-focus {
+    &:hover,
+    &:focus {
       color: $navbar-light-active-color;
     }
   }
@@ -83,6 +84,7 @@
     color: $text-muted;
     font-weight: bold;
     padding-left: $spacer / 2;
+    text-decoration: none;
 
     &:hover {
       color: theme-color("danger");

data/app/assets/stylesheets/blacklight/_header.scss

@@ -44,7 +44,12 @@
   .submit-search-text {
     // hide 'search' label at very small screens
     @media screen and (max-width: breakpoint-max(xs)) {
-      @include sr-only();
+      @if mixin-exists(sr-only) {
+        @include sr-only();
+      }
+      @if mixin-exists(visually-hidden) {
+        @include visually-hidden();
+      }
     }
   }
 }

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

@@ -10,7 +10,7 @@
   <% if @remove_path.present? %>
     <%= link_to(@remove_path, class: 'btn btn-outline-secondary remove') do %>
       <span class="remove-icon" aria-hidden="true">✖</span>
-      <span class="sr-only">
+      <span class="sr-only visually-hidden">
         <%= if @label.blank?
             t('blacklight.search.filters.remove.value', value: @value)
           else

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

@@ -1,9 +1,9 @@
 <%= content_tag :div, id: @id, class: @classes do %>
-  <h2 class="sr-only"><%= t('blacklight.search.search_constraints_header') %></h2>
+  <h2 class="sr-only visually-hidden"><%= t('blacklight.search.search_constraints_header') %></h2>
 
   <%= link_to t('blacklight.search.start_over'), start_over_path, class: "catalog_startOverLink btn btn-primary" %>
 
-  <span class="constraints-label sr-only"><%= t('blacklight.search.filters.title') %></span>
+  <span class="constraints-label sr-only visually-hidden"><%= t('blacklight.search.filters.title') %></span>
   <% if query_constraints_area.present? %>
     <% query_constraints_area.each do |constraint| %>
       <%= constraint %>

data/app/components/blacklight/content_areas_shim.rb

@@ -5,7 +5,8 @@ module Blacklight
   module ContentAreasShim
     # Shim the `with` helper to write content into slots instead
     def with(slot_name, *args, **kwargs, &block)
-      Deprecation.warn('ViewComponents deprecated `with` and it will be removed in ViewComponents 3.0. content_areas. Use slots (https://viewcomponent.org/guide/slots.html) instead.')
+      Deprecation.warn(Blacklight::ContentAreasShim,
+                       'ViewComponents deprecated `with` and it will be removed in ViewComponents 3.0. content_areas. Use slots (https://viewcomponent.org/guide/slots.html) instead.')
       public_send(slot_name, *args, **kwargs, &block)
     end
   end

data/app/components/blacklight/document/thumbnail_component.html.erb

@@ -1,12 +1,12 @@
-<% value = @use_thumbnail_tag ? @presenter.thumbnail.thumbnail_tag(@image_options, 'aria-hidden': true, tabindex: -1, counter: @counter) : @presenter.thumbnail.render(@image_options) %>
+<% value = use_thumbnail_tag_behavior? ? presenter.thumbnail.thumbnail_tag(@image_options, 'aria-hidden': true, tabindex: -1, counter: @counter) : presenter.thumbnail.render(@image_options) %>
 
 <% if value %>
   <div class="document-thumbnail">
-    <% if @use_thumbnail_tag %>
+    <% if use_thumbnail_tag_behavior? %>
       <% warn_about_deprecated_behavior %>
       <%= value %>
     <% else %>
-      <%= helpers.link_to_document(@presenter.document, value, 'aria-hidden': true, tabindex: -1, counter: @counter) %>
+      <%= helpers.link_to_document(presenter.document, value, 'aria-hidden': true, tabindex: -1, counter: @counter) %>
     <% end %>
   </div>
 <% end %>

data/app/components/blacklight/document/thumbnail_component.rb

@@ -9,20 +9,28 @@ module Blacklight
       # @param [Blacklight::DocumentPresenter] presenter
       # @param [Integer] counter
       # @param [Hash] image_options options for the thumbnail presenter's image tag
-      def initialize(presenter:, counter:, image_options: {})
+      def initialize(presenter: nil, document: nil, counter:, image_options: {})
         @presenter = presenter
+        @document = presenter&.document || document
         @counter = counter
         @image_options = { alt: '' }.merge(image_options)
-        @use_thumbnail_tag = !@presenter.thumbnail.instance_of?(Blacklight::ThumbnailPresenter)
       end
 
       def render?
-        @presenter.thumbnail.exists?
+        presenter.thumbnail.exists?
+      end
+
+      def use_thumbnail_tag_behavior?
+        !presenter.thumbnail.instance_of?(Blacklight::ThumbnailPresenter)
       end
 
       def warn_about_deprecated_behavior
         Deprecation.warn(Blacklight::Document::ThumbnailComponent, 'Detected as custom thumbnail presenter; make sure it has a #render method that returns just the thumbnail image tag')
       end
+
+      def presenter
+        @presenter ||= @view_context.document_presenter(@document)
+      end
     end
   end
 end

data/app/components/blacklight/document_component.rb

@@ -25,7 +25,7 @@ module Blacklight
       next static_content if static_content.present?
       next unless component
 
-      Deprecation.warn('Pass the presenter to the DocumentComponent') if @presenter.nil?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Pass the presenter to the DocumentComponent') if @presenter.nil?
 
       component.new(*args, document: @document, presenter: @presenter, document_counter: @document_counter, **kwargs)
     end)
@@ -34,7 +34,7 @@ module Blacklight
     renders_one :metadata, (lambda do |static_content = nil, *args, component: nil, fields: nil, **kwargs|
       next static_content if static_content.present?
 
-      Deprecation.warn('Pass the presenter to the DocumentComponent') if !fields && @presenter.nil?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Pass the presenter to the DocumentComponent') if !fields && @presenter.nil?
 
       component ||= Blacklight::DocumentMetadataComponent
 
@@ -48,9 +48,9 @@ module Blacklight
       next image_options_or_static_content if image_options_or_static_content.is_a? String
 
       component ||= @presenter&.view_config&.thumbnail_component || Blacklight::Document::ThumbnailComponent
-      Deprecation.warn('Pass the presenter to the DocumentComponent') if !component && @presenter.nil?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Pass the presenter to the DocumentComponent') if !component && @presenter.nil?
 
-      component.new(*args, presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
+      component.new(*args, document: @document, presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
     end)
 
     # A container for partials rendered using the view config partials configuration. Its use is discouraged, but necessary until
@@ -93,13 +93,13 @@ module Blacklight
       @id = id || ('document' if show)
       @classes = classes
 
-      Deprecation.warn('Passing embed_component is deprecated') if @embed_component.present?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Passing embed_component is deprecated') if @embed_component.present?
       @embed_component = embed_component
 
-      Deprecation.warn('Passing metadata_component is deprecated') if @metadata_component.present?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Passing metadata_component is deprecated') if @metadata_component.present?
       @metadata_component = metadata_component || Blacklight::DocumentMetadataComponent
 
-      Deprecation.warn('Passing thumbnail_component is deprecated') if @thumbnail_component.present?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Passing thumbnail_component is deprecated') if @thumbnail_component.present?
       @thumbnail_component = thumbnail_component || Blacklight::Document::ThumbnailComponent
 
       @document_counter = document_counter

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

@@ -2,9 +2,11 @@
   <h3 class="card-header p-0 facet-field-heading" id="<%= @facet_field.html_id %>-header">
     <button
       type="button"
-      class="btn btn-block p-2 text-left collapse-toggle <%= "collapsed" if @facet_field.collapsed? %>"
+      class="btn w-100 d-block btn-block p-2 text-start text-left collapse-toggle <%= "collapsed" if @facet_field.collapsed? %>"
       data-toggle="collapse"
+      data-bs-toggle="collapse"
       data-target="#<%= @facet_field.html_id %>"
+      data-bs-target="#<%= @facet_field.html_id %>"
       aria-expanded="<%= @facet_field.collapsed? ? 'false' : 'true' %>"
     >
       <%= label %>

data/app/components/blacklight/facet_field_no_layout_component.rb

@@ -10,7 +10,7 @@ module Blacklight
     def initialize(**); end
 
     def call
-      body
+      body.to_s
     end
   end
 end

data/app/components/blacklight/facet_item_component.rb

@@ -27,7 +27,7 @@ module Blacklight
                   render_facet_value
                 end
 
-      return if content.blank?
+      return '' if content.blank?
       return content unless @wrapping_element
 
       content_tag @wrapping_element, content
@@ -87,7 +87,7 @@ module Blacklight
           # remove link
           link_to(@href, class: "remove") do
             tag.span('✖', class: "remove-icon", aria: { hidden: true }) +
-              tag.span(@view_context.t(:'blacklight.search.facets.selected.remove'), class: 'sr-only')
+              tag.span(@view_context.t(:'blacklight.search.facets.selected.remove'), class: 'sr-only visually-hidden')
           end
       end + render_facet_count(classes: ["selected"])
     end

data/app/components/blacklight/facet_item_pivot_component.rb

@@ -56,7 +56,7 @@ module Blacklight
 
     def facet_toggle_button(id)
       content_tag 'button', class: 'btn facet-toggle-handle collapsed',
-                            data: { toggle: 'collapse', target: "##{id}" },
+                            data: { toggle: 'collapse', 'bs-toggle': 'collapse', target: "##{id}", 'bs-target': "##{id}" },
                             aria: { expanded: false, controls: id, describedby: "#{id}_label" } do
         concat toggle_icon(:show)
         concat toggle_icon(:hide)
@@ -66,7 +66,7 @@ module Blacklight
     def toggle_icon(type)
       content_tag 'span', class: type do
         concat @icons[type]
-        concat content_tag('span', t(type, scope: 'blacklight.search.facets.pivot'), class: 'sr-only')
+        concat content_tag('span', t(type, scope: 'blacklight.search.facets.pivot'), class: 'sr-only visually-hidden')
       end
     end
 

data/app/components/blacklight/metadata_field_layout_component.rb

@@ -25,7 +25,7 @@ module Blacklight
     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')
+      Deprecation.warn(Blacklight::MetadataFieldLayoutComponent, 'The `value` content area is deprecated; render from the values slot instead')
 
       values.first
     end

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

@@ -9,6 +9,8 @@
       data: {
         toggle: 'collapse',
         target: "##{@panel_id}",
+        'bs-toggle': 'collapse',
+        'bs-target': "##{@panel_id}"
       },
       aria: {
         controls: @panel_id,

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

@@ -1,5 +1,5 @@
 <div class="view-type">
-  <span class="sr-only"><%= t('blacklight.search.view_title') %></span>
+  <span class="sr-only visually-hidden"><%= t('blacklight.search.view_title') %></span>
   <div class="view-type-group btn-group">
     <% views.each do |view| %>
       <%= view %>

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

@@ -1,7 +1,7 @@
 <%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', 'aria-label' => scoped_t('submit') do %>
   <%= render_hash_as_hidden_fields(@params) %>
   <% if @search_fields.length > 1 %>
-    <label for="search_field" class="sr-only"><%= scoped_t('search_field.label') %></label>
+    <label for="search_field" class="sr-only visually-hidden"><%= scoped_t('search_field.label') %></label>
   <% end %>
   <div class="input-group">
     <%= prepend %>
@@ -11,12 +11,12 @@
                        options_for_select(@search_fields, h(@search_field)),
                        title: scoped_t('search_field.title'),
                        id: "#{@prefix}search_field",
-                       class: "custom-select search-field") %>
+                       class: "custom-select form-select search-field") %>
     <% elsif @search_fields.length == 1 %>
       <%= hidden_field_tag :search_field, @search_fields.first.last %>
     <% end %>
 
-    <label for="<%= @prefix %><%= @query_param %>" class="sr-only"><%= scoped_t('search.label') %></label>
+    <label for="<%= @prefix %><%= @query_param %>" class="sr-only visually-hidden"><%= scoped_t('search.label') %></label>
     <%= text_field_tag @query_param, @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control rounded-#{@search_fields.length > 1 ? '0' : 'left'}", id: "#{@prefix}q", autocomplete: autocomplete_path.present? ? "off" : "", autofocus: @autofocus, data: { autocomplete_enabled: autocomplete_path.present?, autocomplete_path: autocomplete_path }  %>
 
     <span class="input-group-append">

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

@@ -4,7 +4,7 @@ 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
+        button_tag class: classes, aria: { expanded: false }, data: { toggle: 'dropdown', 'bs-toggle': 'dropdown' } do
           safe_join([label, content_tag(:span, '', class: 'caret')])
         end
       end)

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

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

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

@@ -6,7 +6,7 @@
       <h1 class="modal-title"><%= title %></h1>
     <% end) %>
 
-    <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+    <button type="button" class="blacklight-modal-close btn-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
       <span aria-hidden="true">&times;</span>
     </button>
   </div>

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -14,7 +14,7 @@ module Blacklight
       if action_opts.path
         send(action_opts.path, url_opts)
       elsif url_opts[:id].class.respond_to?(:model_name)
-        url_for([action_opts.key, url_opts[:id]])
+        url_for([action_opts.key.to_sym, url_opts[:id]])
       else
         send("#{action_opts.key}_#{controller_name}_path", url_opts)
       end

data/app/helpers/blacklight/render_partials_helper_behavior.rb

@@ -84,12 +84,16 @@ module Blacklight::RenderPartialsHelperBehavior
   # @param [Hash] locals to pass to the render call
   # @return [String]
   def render_document_index_with_view view, documents, locals = {}
+    view_config = blacklight_config&.view_config(view)
+
+    return render partial: view_config.template, locals: locals.merge(documents: documents, view_config: view_config) if view_config&.template
+
     template = cached_view ['index', view].join('_') do
       find_document_index_template_with_view(view, locals)
     end
 
     if template
-      template.render(self, locals.merge(documents: documents))
+      template.render(self, locals.merge(documents: documents, view_config: view_config))
     else
       ''
     end

data/app/javascript/blacklight/modal.js

@@ -106,7 +106,7 @@ Blacklight.modal.onFailure = function(jqXHR, textStatus, errorThrown) {
 
   var contents = '<div class="modal-header">' +
             '<div class="modal-title">There was a problem with your request.</div>' +
-            '<button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="Close">' +
+            '<button type="button" class="blacklight-modal-close btn-close close" data-dismiss="modal" aria-label="Close">' +
             '  <span aria-hidden="true">&times;</span>' +
             '</button></div>' +
             ' <div class="modal-body"><p>Expected a successful response from the server, but got an error</p>' +

data/app/views/blacklight/nav/_bookmark.html.erb

@@ -1,4 +1,4 @@
 <%= link_to bookmarks_path, id:'bookmarks_nav', class: 'nav-link' do %>
   <%= t('blacklight.header_links.bookmarks') %>
-<span class="badge badge-secondary" data-role='bookmark-counter'><%= current_or_guest_user.bookmarks.count %></span>
+<span class="badge badge-secondary bg-secondary" data-role='bookmark-counter'><%= current_or_guest_user.bookmarks.count %></span>
 <% end %>

data/app/views/bookmarks/index.html.erb

@@ -13,7 +13,7 @@
   <% else %>
     <%= render 'sort_and_per_page' %>
     <%= render partial: 'tools', locals: { document_list: @response.documents } %>
-    <h2 class='section-heading sr-only'><%= t('blacklight.bookmarks.list_title') %></h2>
+    <h2 class='section-heading sr-only visually-hidden'><%= t('blacklight.bookmarks.list_title') %></h2>
     <%= render_document_index %>
     <%= render 'results_pagination' %>
   <% end %>

data/app/views/catalog/_constraints.html.erb

@@ -4,10 +4,10 @@
   <% Deprecation.warn(Blacklight::RenderConstraintsHelperBehavior, 'Constraints helpers or partials were overridden; not using components') %>
   <% if Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) { query_has_constraints? } %>
     <div id="appliedParams" class="clearfix constraints-container">
-      <h2 class="sr-only"><%= t('blacklight.search.search_constraints_header') %></h2>
+      <h2 class="sr-only visually-hidden"><%= t('blacklight.search.search_constraints_header') %></h2>
 
       <%= render 'start_over' %>
-      <span class="constraints-label sr-only"><%= t('blacklight.search.filters.title') %></span>
+      <span class="constraints-label sr-only visually-hidden"><%= t('blacklight.search.filters.title') %></span>
       <%= render_constraints(controller.params != params ? params : search_state) %>
     </div>
   <% end %>