blacklight 8.7.0 → 8.8.0

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

@@ -1,9 +1,10 @@
 // Facet field headings and buttons
 .facet-field-heading {
+  --bl-facet-field-heading-font-weight: #{$headings-font-weight};
   border-bottom: 0;
 
   button {
-    font-weight: $headings-font-weight;
+    font-weight: var(--bl-facet-field-heading-font-weight);
 
     &::after {
       content: "❯";

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

@@ -29,13 +29,6 @@
     @media (min-width: breakpoint-min(lg)) {
       max-width: breakpoint-min(lg) * 0.5;
     }
-
-    &:hover,
-    &:active {
-      background-color: $secondary;
-      border-color: $secondary;
-      box-shadow: none;
-    }
   }
 
   .filter-name:after {

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

@@ -3,6 +3,8 @@
   --bl-facet-active-item-color: #{$facet-active-item-color};
   --bl-facet-margin-bottom: #{$spacer};
   --bl-facet-remove-color: var(--bs-secondary-color);
+  --bl-facet-label-indent: -15px;
+  --bl-facet-label-padding-left: 15px;
 
   --bl-facet-limit-body-padding: #{$spacer};
 
@@ -12,18 +14,7 @@
   --bl-facets-smallish-margin-bottom: #{$spacer};
   --bl-facets-smallish-border-radius: #{$border-radius};
 
-  .navbar-toggler {
-    --bs-navbar-toggler-padding-x: #{$navbar-toggler-padding-x};
-    --bs-navbar-toggler-padding-y: #{$navbar-toggler-padding-y};
-    --bs-navbar-toggler-border-color: #{$navbar-light-toggler-border-color};
-    --bs-navbar-toggler-border-radius: #{$navbar-toggler-border-radius};
-    color: $navbar-light-active-color;
-
-    &:hover,
-    &:focus {
-      color: $navbar-light-active-color;
-    }
-
+  .facet-toggle-button {
     [data-hide-label] {
       display: inline;
     }
@@ -112,6 +103,16 @@
   .card-body {
     padding: var(--bl-facet-limit-body-padding);
   }
+
+  /* Provide a focus ring on the expand/collapse button */
+  .btn {
+    --bs-btn-focus-shadow-rgb: 50, 50, 50;
+    &:focus-visible {
+      border-color: var(--bs-btn-hover-border-color);
+      outline: 0;
+      box-shadow: var(--bs-btn-focus-box-shadow);
+    }
+  }
 }
 
 .facet-limit-active {
@@ -168,9 +169,9 @@
   .facet-label {
     hyphens: auto;
     overflow-wrap: break-word;
-    padding-left: 15px;
+    padding-left: var(--bl-facet-label-padding-left);
     padding-right: 1em;
-    text-indent: -15px;
+    text-indent: var(--bl-facet-label-indent);
   }
 
   .facet-count {

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

@@ -4,7 +4,7 @@
     <%= content_tag :h2, @title, class: 'facets-heading' if @title %>
 
     <%= content_tag :button,
-      class:'navbar-toggler navbar-toggler-right',
+      class: 'btn btn-outline-secondary facet-toggle-button d-block d-lg-none',
       type: 'button',
       data: {
         toggle: 'collapse',

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

@@ -1,4 +1,4 @@
-<%= link_to url, title: label, class: "#{Array(@classes).join(' ')} view-type-#{ @key.to_s.parameterize } #{"active" if selected?}" do %>
+<%= link_to url, title: label, aria: aria_attributes, 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

@@ -25,6 +25,12 @@ module Blacklight
         @view.display_label
       end
 
+      def aria_attributes
+        return unless selected?
+
+        { current: true }
+      end
+
       def url
         helpers.url_for(@search_state.to_h.merge(view: @key))
       end

data/app/components/blacklight/search/facet_suggest_input.html.erb

@@ -0,0 +1,9 @@
+<label for="facet_suggest_<%= facet.key %>">
+  <%= I18n.t('blacklight.search.facets.suggest.label', field_label: presenter&.label) %>
+</label>
+<%= text_field_tag "facet_suggest_#{facet.key}",
+  nil,
+  class: "facet-suggest form-control",
+  data: {facet_field: facet.key},
+  placeholder: I18n.t('blacklight.search.form.search.placeholder')
+%>

data/app/components/blacklight/search/facet_suggest_input.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Search
+    class FacetSuggestInput < Blacklight::Component
+      def initialize(facet:, presenter:)
+        @facet = facet
+        @presenter = presenter
+      end
+
+      private
+
+      attr_accessor :facet, :presenter
+
+      def render?
+        facet&.suggest
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-<nav id="skip-link" role="navigation" class="visually-hidden-focusable sr-only sr-only-focusable" aria-label="<%= t('blacklight.skip_links.label') %>">
+<nav id="skip-link" class="visually-hidden-focusable sr-only sr-only-focusable" aria-label="<%= t('blacklight.skip_links.label') %>">
   <div class="container-xl">
     <%= link_to_main %>
     <%= link_to_search %>

data/app/controllers/concerns/blacklight/catalog.rb

@@ -83,7 +83,11 @@ module Blacklight::Catalog
     @facet = blacklight_config.facet_fields[params[:id]]
     raise ActionController::RoutingError, 'Not Found' unless @facet
 
-    @response = search_service.facet_field_response(@facet.key)
+    @response = if params[:query_fragment].present?
+                  search_service.facet_suggest_response(@facet.key, params[:query_fragment])
+                else
+                  search_service.facet_field_response(@facet.key)
+                end
     @display_facet = @response.aggregations[@facet.field]
 
     @presenter = @facet.presenter.new(@facet, @display_facet, view_context)
@@ -92,6 +96,8 @@ module Blacklight::Catalog
       format.html do
         # Draw the partial for the "more" facet modal window:
         return render layout: false if request.xhr?
+        # Only show the facet names and their values:
+        return render 'facet_values', layout: false if params[:only_values]
         # Otherwise draw the facet selector for users who have javascript disabled.
       end
       format.json

data/app/javascript/blacklight/debounce.js

@@ -0,0 +1,15 @@
+// Usage:
+// ```
+// const basicFunction = (entry) => console.log(entry)
+// const debounced = debounce(basicFunction("I should only be called once"));
+//
+// debounced // does NOT print to the screen because it is invoked again less than 200 milliseconds later
+// debounced // does print to the screen
+// ```
+export default function debounce(func, timeout = 200) {
+    let timer;
+    return (...args) => {
+      clearTimeout(timer);
+      timer = setTimeout(() => { func.apply(this, args); }, timeout);
+    };
+}

data/app/javascript/blacklight/facet_suggest.js

@@ -0,0 +1,26 @@
+import debounce from "blacklight/debounce";
+
+const FacetSuggest = async (e) => {
+  if (e.target.matches('.facet-suggest')) {
+    const queryFragment = e.target.value?.trim();
+    const facetField = e.target.dataset.facetField;
+    if (!facetField) { return; }
+
+    const urlToFetch = `/catalog/facet_suggest/${facetField}/${queryFragment}`
+    const response = await fetch(urlToFetch);
+    if (response.ok) {
+        const blob = await response.blob()
+        const text = await blob.text()
+    
+        const facetArea = document.querySelector('.facet-extended-list');
+    
+        if (text && facetArea) {
+            facetArea.innerHTML = text
+        }
+    }
+  }
+};
+
+document.addEventListener('input', debounce(FacetSuggest));
+
+export default FacetSuggest

data/app/javascript/blacklight/index.js

@@ -1,13 +1,17 @@
 import BookmarkToggle from 'blacklight/bookmark_toggle'
 import ButtonFocus from 'blacklight/button_focus'
+import FacetSuggest from 'blacklight/facet_suggest'
 import Modal from 'blacklight/modal'
+import ModalForm from 'blacklight/modalForm'
 import SearchContext from 'blacklight/search_context'
 import Core from 'blacklight/core'
 
 export default {
   BookmarkToggle,
   ButtonFocus,
+  FacetSuggest,
   Modal,
+  ModalForm,
   SearchContext,
   Core,
   onLoad: Core.onLoad

data/app/javascript/blacklight/modal.js

@@ -52,7 +52,6 @@
   can be a turbo-stream that defines some HTML fragementsand where on the page to put them:
   https://turbo.hotwired.dev/handbook/streams
 */
-import ModalForm from 'blacklight/modalForm'
 
 const Modal = (() => {
   const modal = {}
@@ -149,13 +148,15 @@ const Modal = (() => {
   };
 
   modal.setupModal = function() {
-    // Register both trigger and preserve selectors in ONE event handler, combining
-    // into one selector with a comma, so if something matches BOTH selectors, it
-    // still only gets the event handler called once.
+    // Register several click handlers in ONE event handler for efficiency
+    //
+    // * close button OR click on backdrop (modal.modalSelector) closes modal
+    // * trigger and preserve link in modal functionality -- if somethign matches both trigger and
+    //   preserve, still only called once.
     document.addEventListener('click', (e) => {
       if (e.target.closest(`${modal.triggerLinkSelector}, ${modal.preserveLinkSelector}`))
         modal.modalAjaxLinkClick(e)
-      else if (e.target.closest('[data-bl-dismiss="modal"]'))
+      else if (e.target.matches(`${modal.modalSelector}`) || e.target.closest('[data-bl-dismiss="modal"]'))
         modal.hide()
     })
   };

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -31,7 +31,8 @@ module Blacklight
     end
 
     def in_modal?
-      search_state.params[:action] == "facet"
+      modal_like_actions = %w[facet facet_suggest]
+      modal_like_actions.include? search_state.params[:action]
     end
 
     def modal_path

data/app/services/blacklight/search_service.rb

@@ -62,6 +62,11 @@ module Blacklight
       repository.search(query.merge(extra_controller_params))
     end
 
+    def facet_suggest_response(facet_field, facet_suggestion_query, extra_controller_params = {})
+      query = search_builder.with(search_state).facet(facet_field).facet_suggestion_query(facet_suggestion_query)
+      repository.search(query.merge(extra_controller_params))
+    end
+
     # Get the previous and next document from a search result
     # @return [Blacklight::Solr::Response, Array<Blacklight::SolrDocument>] the solr response and a list of the first and last document
     def previous_and_next_documents_for_search(index, request_params, extra_controller_params = {})

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

@@ -6,6 +6,7 @@
   <% end %>
 
   <% component.with_title { facet_field_label(@facet.key) } %>
+  <%= render Blacklight::Search::FacetSuggestInput.new(facet: @facet, presenter: @presenter) %>
 
   <%= render partial: 'facet_index_navigation' if @facet.index_range && @display_facet.index? %>
 

data/app/views/catalog/facet_values.erb

@@ -0,0 +1,3 @@
+<%= render Blacklight::FacetComponent.new(display_facet: @display_facet,
+                                              blacklight_config: blacklight_config,
+                                              layout: false) %>

data/app/views/kaminari/blacklight/_paginator.html.erb

@@ -11,7 +11,7 @@
 <%= paginator.render do -%>
   <ul class="pagination">
     <%= prev_page_tag %>
-    <%= next_page_tag if Blacklight::Engine.config.blacklight.paginator[:next_page_position] == :before %>
+    <%= next_page_tag if Blacklight::Engine.config.blacklight.paginator[:next_button_position] == :before %>
     <% each_relevant_page do |page| -%>
       <% if page.left_outer? || page.right_outer? || page.inside_window? -%>
         <%= page_tag page %>
@@ -19,6 +19,6 @@
         <%= gap_tag %>
       <% end -%>
     <% end -%>  
-    <%= next_page_tag if Blacklight::Engine.config.blacklight.paginator[:next_page_position] == :after %>
+    <%= next_page_tag if Blacklight::Engine.config.blacklight.paginator[:next_button_position] == :after %>
   </ul>
 <% end -%>

data/app/views/layouts/catalog_result.html.erb

@@ -3,9 +3,9 @@
     <%= yield %>
   </section>
 
-  <section class="<%= show_sidebar_classes %>">
+  <aside class="<%= show_sidebar_classes %>" aria-label="<%= t('.aria.sidebar') %>">
     <%= content_for(:sidebar) %>
-  </section>
+  </aside>
 <% end %>
 
 <%= render template: "layouts/blacklight/base" %>

data/blacklight.gemspec

@@ -49,6 +49,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rubocop-capybara"
   s.add_development_dependency "rubocop-rspec_rails"
   s.add_development_dependency "rubocop-factory_bot"
+  s.add_development_dependency "rspec-benchmark"
   s.add_development_dependency "i18n-tasks", '~> 1.0'
   s.add_development_dependency "solr_wrapper"
 end

data/config/locales/blacklight.ar.yml

@@ -111,6 +111,9 @@ ar:
         sort:
           count: ترتيب رقمي
           index: ترتيب أبجدي
+        suggest:
+          label: الفلتر %{field_label}
+          placeholder: فلتر...
         title: تحديد نطاق البحث
       filters:
         label: "%{label}:"
@@ -219,6 +222,10 @@ ar:
       aria:
         container_label: التنقل الرئيسي
     welcome: مرحبًا!
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: أدوات
   views:
     pagination:
       aria:

data/config/locales/blacklight.de.yml

@@ -102,6 +102,9 @@ de:
         sort:
           count: Numerisch ordnen
           index: A-Z Ordnen
+        suggest:
+          label: Filter %{field_label}
+          placeholder: Filter...
         title: Suche beschränken
       filters:
         label: "%{label}:"
@@ -206,6 +209,10 @@ de:
       aria:
         container_label: Hauptnavigation
     welcome: Willkommen!
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: Werkzeuge
   views:
     pagination:
       aria:

data/config/locales/blacklight.en.yml

@@ -120,6 +120,9 @@ en:
         sort:
           count: Numerical Sort
           index: A-Z Sort
+        suggest:
+          label: "Filter %{field_label}"
+          placeholder: Filter...
         title: Limit your search
       filters:
         label: "%{label}:"
@@ -242,3 +245,7 @@ en:
     pagination_compact:
       next: Next »
       previous: "« Previous"
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: Tools

data/config/locales/blacklight.es.yml

@@ -101,6 +101,9 @@ es:
         sort:
           count: Ordenación numérica
           index: Ordenación A-Z
+        suggest:
+          label: Filtro %{field_label}
+          placeholder: Filtrar...
         title: Limite su búsqueda
       filters:
         label: "%{label}:"
@@ -205,6 +208,10 @@ es:
       aria:
         container_label: Navegación principal
     welcome: "¡Bienvenido!"
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: Herramientas
   views:
     pagination:
       aria:

data/config/locales/blacklight.fr.yml

@@ -101,6 +101,9 @@ fr:
         sort:
           count: Du + au - fréquent
           index: Tri de A à Z
+        suggest:
+          label: Filtre %{field_label}
+          placeholder: Filtre...
         title: Limiter votre recherche
       filters:
         label: "%{label}:"
@@ -205,6 +208,10 @@ fr:
       aria:
         container_label: Navigation principale
     welcome: Welcome!
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: Outils
   views:
     pagination:
       aria:

data/config/locales/blacklight.hu.yml

@@ -99,6 +99,9 @@ hu:
         sort:
           count: Numerikus rendezés
           index: A-Z rendezés
+        suggest:
+          label: Szűrő %{field_label}
+          placeholder: Szűrő...
         title: Szűrje tovább a keresését
       filters:
         label: "%{label}:"
@@ -203,6 +206,10 @@ hu:
       aria:
         container_label: Fő navigáció
     welcome: Üdvözöljük!
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: Eszközök
   views:
     pagination:
       aria:

data/config/locales/blacklight.it.yml

@@ -102,6 +102,9 @@ it:
         sort:
           count: Ordina per numero
           index: Ordina A-Z
+        suggest:
+          label: Filtro %{field_label}
+          placeholder: Filtro...
         title: Affina la ricerca
       filters:
         label: "%{label}:"
@@ -206,6 +209,10 @@ it:
       aria:
         container_label: Navigazione principale
     welcome: Benvenuti!
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: Utensili
   views:
     pagination:
       aria:

data/config/locales/blacklight.nl.yml

@@ -99,6 +99,9 @@ nl:
         sort:
           count: Numeriek sorteren
           index: A-Z Sorteren
+        suggest:
+          label: Filteren %{field_label}
+          placeholder: Filter...
         title: Verfijn uw zoekopdracht
       filters:
         label: "%{label}:"
@@ -203,6 +206,10 @@ nl:
       aria:
         container_label: Hoofdnavigatie
     welcome: Welkom!
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: Hulpmiddelen
   views:
     pagination:
       aria:

data/config/locales/blacklight.pt-BR.yml

@@ -100,6 +100,9 @@ pt-BR:
         sort:
           count: Ordenar por Número
           index: Ordem Alfabética A-Z
+        suggest:
+          label: Filtro %{field_label}
+          placeholder: Filtro...
         title: Filtre sua busca
       filters:
         label: "%{label}:"
@@ -204,6 +207,10 @@ pt-BR:
       aria:
         container_label: Navegação principal
     welcome: Bem-Vindo!
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: Ferramentas
   views:
     pagination:
       aria:

data/config/locales/blacklight.sq.yml

@@ -99,6 +99,9 @@ sq:
         sort:
           count: Renditja numerike
           index: A-Z Renditja
+        suggest:
+          label: Filtri %{field_label}
+          placeholder: Filtro...
         title: Kufizo këkimin
       filters:
         label: "%{label}:"
@@ -203,6 +206,10 @@ sq:
       aria:
         container_label: Lundrimi kryesor
     welcome: Mirësevini!
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: Mjetet
   views:
     pagination:
       aria:

data/config/locales/blacklight.zh.yml

@@ -99,6 +99,9 @@ zh:
         sort:
           count: 按数量排序
           index: 按字母排序
+        suggest:
+          label: 过滤器 %{field_label}
+          placeholder: 筛选...
         title: 限定搜索
       filters:
         label: "%{label}:"
@@ -203,6 +206,10 @@ zh:
       aria:
         container_label: 主导航
     welcome: 欢迎!
+  layouts:
+    catalog_result:
+      aria:
+        sidebar: 工具
   views:
     pagination:
       aria:

data/lib/blacklight/configuration.rb

@@ -35,7 +35,8 @@ module Blacklight
       end
     end
 
-    BASIC_SEARCH_PARAMETERS = [:q, :qt, :page, :per_page, :search_field, :sort, :controller, :action, :'facet.page', :'facet.prefix', :'facet.sort', :rows, :format, :view].freeze
+    BASIC_SEARCH_PARAMETERS = [:q, :qt, :page, :per_page, :search_field, :sort, :controller, :action, :'facet.page', :'facet.prefix', :'facet.sort', :rows, :format, :view, :id, :facet_id,
+                               :query_fragment, :only_values].freeze
     ADVANCED_SEARCH_PARAMETERS = [{ clause: {} }, :op].freeze
 
     # rubocop:disable Metrics/BlockLength

data/lib/blacklight/routes/searchable.rb

@@ -18,6 +18,7 @@ module Blacklight
         mapper.get "opensearch"
         mapper.get 'suggest', as: 'suggest_index'
         mapper.get "facet/:id", action: 'facet', as: 'facet'
+        mapper.get "facet_suggest/:id/(:query_fragment)", action: 'facet', as: 'facet_suggest', defaults: { only_values: true }
       end
     end
   end

data/lib/blacklight/search_builder.rb

@@ -224,6 +224,19 @@ module Blacklight
       @facet
     end
 
+    def facet_suggestion_query=(value)
+      params_will_change!
+      @facet_suggestion_query = value
+    end
+
+    def facet_suggestion_query(value = nil)
+      if value
+        self.facet_suggestion_query = value
+        return self
+      end
+      @facet_suggestion_query
+    end
+
     # Decode the user provided 'sort' parameter into a sort string that can be
     # passed to the search.  This sanitizes the input by ensuring only
     # configured search values are passed through to the search.

data/lib/blacklight/solr/response/facets.rb

@@ -157,7 +157,7 @@ module Blacklight::Solr::Response::Facets
   #   facet data in the response
   def default_aggregations
     @default_aggregations ||= begin
-      h = Hash.new { |key| null_facet_field_object(key) }
+      h = Hash.new { |_hash, key| null_facet_field_object(key) }
       h.with_indifferent_access
     end
   end

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -10,7 +10,8 @@ module Blacklight::Solr
         :add_query_to_solr, :add_facet_fq_to_solr,
         :add_facetting_to_solr, :add_solr_fields_to_query, :add_paging_to_solr,
         :add_sorting_to_solr, :add_group_config_to_solr,
-        :add_facet_paging_to_solr, :add_adv_search_clauses,
+        :add_facet_paging_to_solr, :add_facet_suggestion_parameters,
+        :add_adv_search_clauses,
         :add_additional_filters
       ]
     end
@@ -276,6 +277,13 @@ module Blacklight::Solr
       solr_params[:"f.#{facet_config.field}.facet.prefix"] = prefix if prefix
     end
 
+    def add_facet_suggestion_parameters(solr_params)
+      return if facet.blank? || facet_suggestion_query.blank?
+
+      solr_params[:'facet.contains'] = facet_suggestion_query[0..50]
+      solr_params[:'facet.contains.ignoreCase'] = true
+    end
+
     def with_ex_local_param(ex, value)
       if ex
         "{!ex=#{ex}}#{value}"