has-tabbed

Small library that adds CSS class to html when user starts using keyboard to navigate, and removes it if user clicks anywhere.

This enables you to have focus outline only when user is using keyboard.

Demo | Blog post

Usage

Get it from npm

npm install --save has-tabbed

and use it

import HasTabbed from 'has-tabbed';
 
const tabbed = new HasTabbed();

That's it. By default library is active when instance is created. You can control it manually by using addEvents and removeEvents methods.

// Removes all listeners and CSS class
tabbed.removeEvents();
 
// Adds listeners again
tabbed.addEvents();

Then you can use has-tabbed class in your CSS

/* This is naive example used in the demo */
* {
  outline: 3px solid transparent;
  outline-offset: 0.3rem;
}
 
.has-tabbed *:focus {
  outline: 3px solid #409ad7;
}

Options

Library accepts a single options object with the following properties:

• className (default has-tabbed)

  CSS class name which will be added to the html element.

• triggerOnAllKeys (default false)

  If you want to add CSS class on all keyboard events not only when user presses tab, change this one to true

import HasTabbed from 'has-tabbed';
 
const tabbed = new HasTabbed({
  className: 'navigating-using-keyboard',
  triggerOnAllKeys: true,
});

v1.0.0 breaking changes

• className property is now replaced with an options object.
• Default class name is changed from --tabbed to has-tabbed.

Old school usage

You should use ES modules, but you can use it directly in the browser.

<!-- copy "has-tabbed.js" to your project -->
<script src="has-tabbed.js"></script>
<script>
  var tabbed = new HasTabbed();
</script>