Commit cd33481f authored by Kyle Keating's avatar Kyle Keating Committed by Robert Knight

Improve accessability for toggle buttons

- Add aria attribute for show / hide side bar
- Add aria attribute for show / hide highlights
- Fix a bug that prevents the correct class from showing on the highlight icon when highlights are initially disabled
parent 20c3b5c0
Plugin = require('../plugin') Plugin = require('../plugin')
$ = require('jquery') $ = require('jquery')
configFrom = require('../config/index')
makeButton = (item) -> makeButton = (item) ->
anchor = $('<button></button>') anchor = $('<button></button>')
.attr('href', '') .attr('href', '')
.attr('title', item.title) .attr('title', item.title)
.attr('name', item.name) .attr('name', item.name)
.attr('aria-pressed', item.ariaPressed)
.on(item.on) .on(item.on)
.addClass('annotator-frame-button') .addClass('annotator-frame-button')
.addClass(item.class) .addClass(item.class)
...@@ -27,6 +30,10 @@ module.exports = class Toolbar extends Plugin ...@@ -27,6 +30,10 @@ module.exports = class Toolbar extends Plugin
else else
$(@element).append @toolbar $(@element).append @toolbar
config = configFrom(window);
# config.showHighlights will be either 'always' or 'never'
highlightsAreVisible = if config.showHighlights == 'never' then false else true
items = [ items = [
"title": "Close Sidebar" "title": "Close Sidebar"
"class": "annotator-frame-button--sidebar_close h-icon-close" "class": "annotator-frame-button--sidebar_close h-icon-close"
...@@ -39,6 +46,7 @@ module.exports = class Toolbar extends Plugin ...@@ -39,6 +46,7 @@ module.exports = class Toolbar extends Plugin
@toolbar.find('[name=sidebar-close]').hide(); @toolbar.find('[name=sidebar-close]').hide();
, ,
"title": "Toggle or Resize Sidebar" "title": "Toggle or Resize Sidebar"
"ariaPressed": config.openSidebar
"class": "annotator-frame-button--sidebar_toggle h-icon-chevron-left" "class": "annotator-frame-button--sidebar_toggle h-icon-chevron-left"
"name": "sidebar-toggle" "name": "sidebar-toggle"
"on": "on":
...@@ -48,12 +56,15 @@ module.exports = class Toolbar extends Plugin ...@@ -48,12 +56,15 @@ module.exports = class Toolbar extends Plugin
collapsed = @annotator.frame.hasClass('annotator-collapsed') collapsed = @annotator.frame.hasClass('annotator-collapsed')
if collapsed if collapsed
@annotator.show() @annotator.show()
event.target.setAttribute('aria-pressed', true);
else else
@annotator.hide() @annotator.hide()
event.target.setAttribute('aria-pressed', false);
, ,
"title": "Hide Highlights" "title": "Toggle Highlights Visibility"
"class": "h-icon-visibility" "class": if highlightsAreVisible then 'h-icon-visibility' else 'h-icon-visibility-off'
"name": "highlight-visibility" "name": "highlight-visibility"
"ariaPressed": highlightsAreVisible
"on": "on":
"click": (event) => "click": (event) =>
event.preventDefault() event.preventDefault()
...@@ -87,12 +98,12 @@ module.exports = class Toolbar extends Plugin ...@@ -87,12 +98,12 @@ module.exports = class Toolbar extends Plugin
$('[name=highlight-visibility]') $('[name=highlight-visibility]')
.removeClass('h-icon-visibility-off') .removeClass('h-icon-visibility-off')
.addClass('h-icon-visibility') .addClass('h-icon-visibility')
.prop('title', 'Hide Highlights'); .attr('aria-pressed', 'true')
else else
$('[name=highlight-visibility]') $('[name=highlight-visibility]')
.removeClass('h-icon-visibility') .removeClass('h-icon-visibility')
.addClass('h-icon-visibility-off') .addClass('h-icon-visibility-off')
.prop('title', 'Show Highlights'); .attr('aria-pressed', 'false')
disableMinimizeBtn: () -> disableMinimizeBtn: () ->
$('[name=sidebar-toggle]').remove(); $('[name=sidebar-toggle]').remove();
......
...@@ -107,7 +107,7 @@ $base-font-size: 14px; ...@@ -107,7 +107,7 @@ $base-font-size: 14px;
} }
.annotator-frame-button { .annotator-frame-button {
transition: background-color 0.25s 0.25s; transition: background-color 0.25s;
@include smallshadow; @include smallshadow;
background: $white; background: $white;
border: solid 1px $gray-lighter; border: solid 1px $gray-lighter;
...@@ -121,7 +121,6 @@ $base-font-size: 14px; ...@@ -121,7 +121,6 @@ $base-font-size: 14px;
margin-bottom: 5px; margin-bottom: 5px;
&:active { &:active {
transition: background-color 0.25s;
background-color: $gray-light; background-color: $gray-light;
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment