has-tabbed
:focus-visible
Today, :focus-visible is widely supported, so you probably want to use that instead of this library. However, I'll keep it around for posterity and poor souls that still have to support old browsers.
What is this?
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.
tabbed.removeEvents();
tabbed.addEvents();
Then you can use has-tabbed
class in your CSS
* {
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.
<script src="has-tabbed.js"></script>
<script>
var tabbed = new HasTabbed();
</script>