Instantly share code, notes, and snippets.

Embed
What would you like to do?
Cross-Lib accessible outline removal
/*!
Copyright (c) <2012> <Arieh Glazer>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
//Accessible outline removal
//can be used with delegation or on specific elements (by query)
//should work on all modern browsers + IE8+
//method inspired by:http://www.paciellogroup.com/blog/2012/04/how-to-remove-css-outlines-in-an-accessible-manner/
//example: http://jsfiddle.net/JzEyP/8/
(function() {
function hasClass(el, name) {
if ('classList' in el) return el.classList.contains(name);
return el.className.explode(' ').indexOf(name) > -1;
}
this.Outliner = function Outliner(opts) {
var key;
for (key in opts) if (key in this.options) this.options[key] = opts[key];
this.handleEvent = this.handleEvent.bind(this);
if (this.options.useDelegation) this.className = this.options.selector.replace('.', '');
this.generate();
this.attach();
};
Outliner.prototype = {
constructor: Outliner,
options: {
selector: 'a',
useDelegation: false
},
generate: function() {
this.element = document.createElement('style');
document.head.appendChild(this.element);
},
handleEvent: function(e) {
if (this.options.useDelegation && hasClass(e.target, this.className) == false) return;
switch (e.type) {
case 'mouseover':
this.removeOutline();
break;
case 'keydown':
this.restoreOutline();
break;
}
},
attach: function() {
var compat = 'addEventListener' in document,
attachee = compat ? this : this.handleEvent,
key_ev = compat ? 'keydown' : 'onkeydown',
mouse_ev = compat ? 'mouseover' : 'onmouseover',
i, el;
this.elements = this.options.useDelegation ?
[document.body] :
document.querySelectorAll(this.options.selector);
for (i = 0; el = this.elements[i]; i++) {
el[compat ? 'addEventListener' : 'attachEvent'](key_ev, attachee, false);
el[compat ? 'addEventListener' : 'attachEvent'](mouse_ev, attachee, false);
}
},
removeOutline: function() {
this.element.innerHTML = this.options.selector + ' {outline:none}';
},
restoreOutline: function() {
this.element.innerHTML = '';
},
detach: function() {
var compat = 'addEventListener' in document,
attachee = compat ? this : this.handleEvent,
key_ev = compat ? 'keydown' : 'onkeydown',
mouse_ev = compat ? 'mouseover' : 'onmouseover',
i, el;
for (i = 0; el = this.elements[i]; i++) {
el[compat ? 'removeEventListener' : 'detatchEvent'](key_ev, attachee, false);
el[compat ? 'removeEventListener' : 'detatchEvent'](mouse_ev, attachee, false);
}
this.elements = {};
document.head.removeElement(this.element);
this.element = null;
}
};
}).call(this);
new this.Outliner({
useDelegation: 'true',
selector: '.use'
});
@stevefaulkner

This comment has been minimized.

stevefaulkner commented Apr 24, 2012

lindsay evans has made a script as well https://github.com/lindsayevans/outline.js uses onmousedown instead of onmouseover which is probably a better choice.

@jensgro

This comment has been minimized.

Owner

jensgro commented Apr 24, 2012

Thanks for the hint. And the script is way smaller :-)

@rdy4ever

This comment has been minimized.

rdy4ever commented Jan 26, 2018

Do we really need a library to achieve this? And is detecting mouse movement the best approach? What if a user uses both mouse and keyboard?
This is how I do it in my projects:

  1. By default I disable outline with this css declaration:
    body:not(.accesibility) a{
    outline:none!important;
    }
  2. If I detect the use of the TAB key (this catches the user intention to navigate via keybord), I add the "accesibility" class to the body via a simple JS function:
    $(document).keyup(function(e) {
    if (e.keyCode === 9) {// tab
    $("body").addClass("accesibility");
    }
    });
    This invalidates the CSS rule.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment