relative-dir.js

A JavaScript library that transforms a piece of text at a breakpoint as well as produces a screen reader specific version.

Why?

The specific use case this was created for was for the use of relative directions such as "left, right" to refer to the UI. With responsive design becoming so prevalent you need to be a little more careful when you use these as the element being referred to may not always be to the left.

Installing

Bower

bower install --save relative-dir.js

NPM

npm install --save relative-dir.js

Including

<script src="bower_components/relative-dir.js/src/relative-dir.js"></script>

Usage

This will change the span's content to "above" when the viewport is less than 600 pixels wide.

<span class="relative-dir" data-breakpoint="600" data-text="above">left</span>
<script>
  // Initialise
  relativeDir();
</script>

Screen reader text

The optional data-accessible-text attribute can be used to specify a screen reader version of the text explicitly.

<span class="relative-dir" data-breakpoint="600" data-text="right" data-accessible-text="above">left</span>

This will transform to this, where the element with aria-hidden="true" will change depending on viewport width.

<span class="relative-dir" data-breakpoint="600" data-text="above">
  <span aria-hidden="true">to the left</span>
  <span style="position: absolute; left: -9999px;">above</span>
</span>