blacklight-hierarchy 5.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05896464df5a8c0e3b6d878771afb366c74eb679a9acbb3cc91b48fc1ec21a67'
-  data.tar.gz: f6544b27132185268d971b49e634b6f83a4ad8986e78014f65cc121d233a7fb1
+  metadata.gz: ee133f1b21f148557b8c40603fde045e4c79fbcf41fd6baa02883a07341c399c
+  data.tar.gz: 20badd3b19799248b0da5e8191921e49a3835e52f5c0a044f88f5c4eb27490e8
 SHA512:
-  metadata.gz: e239a2df4fac7caf7a0cce0917fd361c04c1a29ba904246275a592769ede706425cf8a4573c2734829f402f43555c76d3b8b393b6a645350644e4aabe60d5659
-  data.tar.gz: c727ad909a5820f59e4484ef3cf517ade8e48ec61646b943d79f1a52991e2eff290a73bc2033f00bfe62d418ddedc1ebb138fa9f246fc8713857cca1aff34028
+  metadata.gz: b4ad69b3c7dee5a5ac12f430affc11f43f67b572533bcc9b456e2ec7321a329de7f4ac407e87679e6dacf63c3408d110fbcf4107496e4c665a2f464c2f650531
+  data.tar.gz: 6c8498f864b8b6ae8e71863d2a0cb249470000852b5907101aadc86590e6975c73c91ae6b3d5e4c6e23003a7a8cc59279fa7dde5bf258556f02a155ec94cde6a

data/.github/workflows/ruby.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.7, 3.0]
+        ruby: [2.7, '3.0']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

data/README.md

@@ -83,15 +83,17 @@ Facet fields should be added for each permutation of hierarchy key and term valu
 config.facet_display[:hierarchy].each{ |k,v| puts "#{k}_#{v}" }
 ```
 
-### Overriding the icon
-The icon is available in an engine configuration.  You can change them in an initializer in your app.
+### Changing the icons
+We store our closed/open icons as the SASS variables `$b-h-closed-icon` and `$b-h-closed-icon` in `hierarchy.scss`. By default we use SVGs provided by the [Font Awesome](https://github.com/FortAwesome/Font-Awesome) library. To change the icon, reassign these SASS variables with new SVG code. 
 
-```ruby
-Blacklight::Hierarchy::Engine.config.closed_icon = '➕'
-Blacklight::Hierarchy::Engine.config.opened_icon = '➖'
+```scss
+  /* app/assets/stylesheets/blacklight/hierarchy/hierarchy.scss */
 
+  // plus sign
+  $b-h-closed-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d='M200 344V280H136C122.7 280 112 269.3 112 256C112 242.7 122.7 232 136 232H200V168C200 154.7 210.7 144 224 144C237.3 144 248 154.7 248 168V232H312C325.3 232 336 242.7 336 256C336 269.3 325.3 280 312 280H248V344C248 357.3 237.3 368 224 368C210.7 368 200 357.3 200 344zM0 96C0 60.65 28.65 32 64 32H384C419.3 32 448 60.65 448 96V416C448 451.3 419.3 480 384 480H64C28.65 480 0 451.3 0 416V96zM48 96V416C48 424.8 55.16 432 64 432H384C392.8 432 400 424.8 400 416V96C400 87.16 392.8 80 384 80H64C55.16 80 48 87.16 48 96z'/></svg>") !default;
 ```
 
+
 ### Aria Labels
 For screen reader purposes we have used "Toggle subgroup" as the aria-label attribute of the button.  This is internationalized using rails' i18n feature.
 

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

@@ -19,6 +19,7 @@ Blacklight.onLoad(function(){
     $(Blacklight.do_hierarchical_facet_expand_contract_behavior.list, this).each(function() {
       if($('span.selected', this).length != 0){
         li.addClass('twiddle-open');
+        li.children('.collapse').addClass('in');
       }
     });
 

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

@@ -1,3 +1,8 @@
+// plus sign
+$b-h-closed-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d='M200 344V280H136C122.7 280 112 269.3 112 256C112 242.7 122.7 232 136 232H200V168C200 154.7 210.7 144 224 144C237.3 144 248 154.7 248 168V232H312C325.3 232 336 242.7 336 256C336 269.3 325.3 280 312 280H248V344C248 357.3 237.3 368 224 368C210.7 368 200 357.3 200 344zM0 96C0 60.65 28.65 32 64 32H384C419.3 32 448 60.65 448 96V416C448 451.3 419.3 480 384 480H64C28.65 480 0 451.3 0 416V96zM48 96V416C48 424.8 55.16 432 64 432H384C392.8 432 400 424.8 400 416V96C400 87.16 392.8 80 384 80H64C55.16 80 48 87.16 48 96z'/></svg>") !default;
+// minus sign
+$b-h-opened-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d='M312 232C325.3 232 336 242.7 336 256C336 269.3 325.3 280 312 280H136C122.7 280 112 269.3 112 256C112 242.7 122.7 232 136 232H312zM0 96C0 60.65 28.65 32 64 32H384C419.3 32 448 60.65 448 96V416C448 451.3 419.3 480 384 480H64C28.65 480 0 451.3 0 416V96zM48 96V416C48 424.8 55.16 432 64 432H384C392.8 432 400 424.8 400 416V96C400 87.16 392.8 80 384 80H64C55.16 80 48 87.16 48 96z'/></svg>") !default;
+
 $text-muted: #777 !default;
 
 .facet-hierarchy {
@@ -34,8 +39,21 @@ $text-muted: #777 !default;
     }
   }
 
+  .twiddle>.toggle-handle {
+    background-color: transparent;
+  }
+
+  .twiddle>.toggle-handle .toggle-icon {
+    background-position: center;
+    background-repeat: no-repeat;
+    margin-top: 3px;
+    min-height: 20px;
+    min-width: 20px;
+  }
+
   .twiddle>.toggle-handle .closed {
-    display: inline;
+    background-image: escape-svg($b-h-closed-icon);
+    display: inline-block;
   }
 
   .twiddle>.toggle-handle .opened {
@@ -47,7 +65,8 @@ $text-muted: #777 !default;
   }
 
   .twiddle-open>.toggle-handle .opened {
-    display: inline;
+    background-image: escape-svg($b-h-opened-icon);
+    display: inline-block;
   }
 
   .h-leaf {

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

@@ -10,7 +10,7 @@
   <% end %>
 
   <% unless subset.empty? %>
-    <ul id="<%= ul_id %>" class="collapse" data-b-h-collapsible-target="list" role=\"group\">
+    <ul id="<%= ul_id %>" class="collapse" data-b-h-collapsible-target="list" role="group">
     <% subset.keys.sort.each do |subkey| %>
       <%= render self.class.new(field_name: field_name, tree: subset[subkey], key: subkey) %>
     <% end %>

data/app/components/blacklight/hierarchy/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 %>
     <ul class="facet-hierarchy" role="tree">
       <% tree.keys.sort.collect do |key| %>
         <%= render Blacklight::Hierarchy::FacetFieldComponent.new(field_name: @facet_field.facet_field.field, tree: tree[key], key: key) %>

data/app/helpers/blacklight/hierarchy_helper.rb

@@ -17,11 +17,13 @@ module Blacklight::HierarchyHelper
                data: {
                  action: 'click->b-h-collapsible#toggle',
                  toggle: 'collapse',
-                 target: "##{controls}"
+                 bs_toggle: 'collapse',
+                 target: "##{controls}",
+                 bs_target: "##{controls}"
                },
                class: 'toggle-handle') do
-      tag.span(Blacklight::Hierarchy::Engine.config.closed_icon, :'aria-hidden' => 'true', class: 'closed') +
-      tag.span(Blacklight::Hierarchy::Engine.config.opened_icon, :'aria-hidden' => 'true', class: 'opened')
+      tag.div( :'aria-hidden' => 'true', class: 'closed toggle-icon') +
+      tag.div( :'aria-hidden' => 'true', class: 'opened toggle-icon')
     end
   end
 

data/blacklight-hierarchy.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'blacklight', '~> 7.13'
+  s.add_dependency 'blacklight', '~> 7.18'
   s.add_dependency 'rails', '>= 5.1', '< 7'
   s.add_dependency 'deprecation'
 

data/lib/blacklight/hierarchy/engine.rb

@@ -4,8 +4,6 @@ require 'rails'
 module Blacklight
   module Hierarchy
     class Engine < Rails::Engine
-      config.closed_icon = '⊞'
-      config.opened_icon = '⊟'
     end
   end
 end

data/lib/blacklight/hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Hierarchy
-    VERSION = '5.1.0'.freeze
+    VERSION = '6.0.0'.freeze
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-hierarchy",
-  "version": "5.1.0",
+  "version": "5.4.0",
   "description": "[![Build Status](https://github.com/sul-dlss/blacklight-hierarchy/workflows/CI/badge.svg)](https://github.com/sul-dlss/blacklight-hierarchy/actions?query=branch%3Amain)",
   "main": "app/assets/javascripts/blacklight/hierarchy/hierarchy.js",
   "files": [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Michael B. Klein
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.13'
+        version: '7.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.13'
+        version: '7.18'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +194,7 @@ files:
 homepage: https://github.com/sul-dlss/blacklight-hierarchy
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -209,8 +209,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Hierarchical Facets for Blacklight
 test_files: