Skip to content

Instantly share code, notes, and snippets.

@neodigm
Last active March 27, 2024 16:48
Show Gist options
  • Save neodigm/bf64202df7ff854c910977eb1f2515a0 to your computer and use it in GitHub Desktop.
Save neodigm/bf64202df7ff854c910977eb1f2515a0 to your computer and use it in GitHub Desktop.
Flick Carousel ARIA-HIDDEN observer
class FlickPatch { // Flick Carousel ARIA-HIDDEN observer
constructor(_d, _sQ) {
this._d = _d; this._sQ = _sQ;
this.aF = []; this.aObs = [];
}
init() { //
this.aF = Array.from( this._d.querySelectorAll( this._sQ ))
if( this.aF.length ){
this.aObs = []
this.aF.forEach( ( eF )=>{
const oObs = new MutationObserver( flickPatch.removeAttr );
oObs.observe( eF, { attributes: true, childList: true, subtree: true } );
this.aObs.push( oObs )
})
}
return this;
}
removeAttr( aObs ){ //
if( aObs.length ){
aObs.forEach( ( elO )=>{
if( elO?.target ){
[ ... elO.target.querySelectorAll( "[aria-hidden='true']" )].forEach( ( eH )=>{
eH.removeAttribute("aria-hidden")
})
}
})
}
}
}
//. Usage
let flickPatch = {}
document.addEventListener("DOMContentLoaded", ( ev )=>{
setTimeout( ()=>{
flickPatch = new FlickPatch( document, ".flickity-slider" )
flickPatch.init()
}, 8e3 )
})
@TJPar
Copy link

TJPar commented Mar 26, 2024

I used the following approach:

1. Use data Attributes for URLs instead of tags
First, modify your HTML structure by removing the tags from the carousel cells and instead use data attributes to store the URL you want to navigate to. Here's an example of how a carousel cell could be modified:

<div class="carousel-cell" data-url="http://www.example.com">
<p>YOUR CELL CONTENT</>                   
</div>

2. Add JavaScript Event Listeners
Next, use JavaScript to add click event listeners to these carousel cells. When a cell is clicked, the browser will navigate to the URL specified in the data-url attribute. This script ensures that even cells marked with aria-hidden="true" are accessible, as the event listener is attached directly to the cell, and not to an tag that would be hidden from screen readers.

document.querySelectorAll('.carousel-cell').forEach(cell => {
  cell.addEventListener('click', function() {
    const url = this.getAttribute('data-url');
    if(url) {
      window.location.href = url;
    }
  });
});

or do it with jQuery

$('.carousel-cell').click(function() {
  const url = $(this).data('url');
  if(url) {
    window.location.href = url;
  }
});

Considerations:
Accessibility: This approach addresses the accessibility concern by removing aria-hidden="true" from interfering with the link functionality. However, ensure that these interactive cells are properly labeled with aria attributes to indicate their role and action to assistive technologies. For example, use aria-role="button" if the action is similar to a button click.

@GLips
Copy link

GLips commented Mar 27, 2024

This might work for your use case, but I don't think it's a great general solution @TJPar.

For one, the divs won't be keyboard accessible. Even with the addition of the aria-role, someone hitting enter on a focused div won't trigger the event listener. Also, this won't support cmd+clicks to open in new tabs nor will it show the URL preview in the bottom left of the browser window on hover.

My understanding is that it is accurate for aria-hidden labels to be applied to carousel slides that are outside the viewport, and their non-interactivity to screenreaders is a feature, not a bug.

@TJPar
Copy link

TJPar commented Mar 27, 2024

You're right. Ironically, by employing this technique to attain a 100 accessibility score in Lighthouse, it becomes less accessible. I had hoped for reduced scripting. Thanks for taking the time to review my approach and provide feedback; I'll incorporate neodigm's method with your modifications.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment