Merge pull request #2126 from labradford/arclight-616-screenreader-duplicate-search

ability to add aria-hidden to blacklight icon

Author: mejackreed

app/models/blacklight/icon.rb

@@ -7,9 +7,10 @@ class Icon
     # @param [String, Symbol] icon_name
     # @param [Hash] options
     # @param [String] classes additional classes separated by a string
-    def initialize(icon_name, classes: '')
+    def initialize(icon_name, classes: '', aria_hidden: false)
       @icon_name = icon_name
       @classes = classes
+      @aria_hidden = aria_hidden
     end
 
     ##
@@ -23,7 +24,8 @@ def svg
     # @return [Hash]
     def options
       {
-        class: classes
+        class: classes,
+        "aria-hidden": (true if @aria_hidden)
       }
     end
 

app/views/catalog/_search_form.html.erb

@@ -20,7 +20,7 @@
     <span class="input-group-append">
       <button type="submit" class="btn btn-primary search-btn" id="search">
         <span class="submit-search-text"><%= t('blacklight.search.form.submit') %></span>
-        <%= blacklight_icon :search %>
+        <%= blacklight_icon :search, aria_hidden: true %>
       </button>
     </span>
   </div>

spec/models/blacklight/icon_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::Icon do
-  subject { described_class.new(:search, classes: 'awesome') }
+  subject { described_class.new(:search, classes: 'awesome', aria_hidden: true) }
 
   describe '#svg' do
     it 'returns a string' do
@@ -17,6 +17,20 @@
     it 'applies options classes and default class' do
       expect(subject.options[:class]).to eq 'blacklight-icons awesome'
     end
+    it 'applies options aria-hidden=true' do
+      expect(subject.options[:'aria-hidden']).to be true
+    end
+    context 'no options provided' do
+      subject { described_class.new(:view) }
+
+      it 'applies default class with no options' do
+        expect(subject.options[:class]).to eq 'blacklight-icons'
+      end
+
+      it 'has no aria-hidden attribute with no options' do
+        expect(subject.options[:'aria-hidden']).to be nil
+      end
+    end
   end
 
   describe '#path' do