moxystudio / js-keyboard-only-outlines

Disable outlines caused by navigation methods other than keyboard

keyboard-only-outlines

Disable outlines displayed when using navigation methods other than keyboard navigation (e.g.: tab).

By default, some browsers, such as Firefox and Edge, set input borders on focus according to the host Operating System theme. This package does not disable borders, as it may interfere with the user's own styles. This is only apparent when users don't explicitly define a border for their inputs.

You can see it working in the demo page.

Installation

$ npm install @moxy/keyboard-only-outlines

This library is written in modern JavaScript and is published in both CommonJS and ES module transpiled variants. If you target older browsers please make sure to transpile accordingly.

Usage

import keyboardOnlyOutlines from '@moxy/keyboard-only-outlines'

const dispose = keyboardOnlyOutlines()
// dispose will be a function which deactivates this behaviour and can be called at any time

The function may also be invoked with the following options:

keyboardOnlyOutlines({ styles: ..., stylesheetTarget: ... })

Where styles represents the styles to apply when a focus event is caused by mouse navigation, and stylesheetTarget is the node which will receive the aforementioned style. The latter option is particularly useful when dealing with ShadowDOMs.

These options have the following default values:

const defaultOptions = {
    styles: `
*:focus {
    outline: none !important;
}
*::-moz-focus-inner {
    border: none !important;
}`,
    stylesheetTarget: document.head,
};

Tests

$ npm test
$ npm test -- --watch # during development

License

Released under the MIT License.

js-keyboard-only-outlines's Issues

please transpile to es5 its breaking ie11

please

Investigate why the demo is not working on Edge

Take care of special FF styles?

FF applies some weird styles on buttons and inputs:

::-moz-focus-inner  /* Weird dashed outline on the text inside the button */
:moz-focusring /* Blue thingy around the element, but it's not an outline.. it's actually a border */

Fixing ::-moz-focus-inner seems easy by setting border-style: none; in the styles. Fixing :moz-focusring is difficult because it uses border, which we can't set to none because it will remove all the borders. Note that this only happens if the user hasn't defined a border themselves. Perhaps, we shouldn't do nothing regarding this pseudostate but instead simply document it (and change our demo to have set the inputs border explicitly).

package is breaking in edge when using alongside with react-intersection-observer

Using:
js-keyboard-only-outlines v 1.0.4
@researchgate/react-intersection-observer v 1.0.1

[Edge] Rendering issues when using this package alongside with react-intersection-observer, the content is not displayed properly

Demo toggle state button makes state not bold

When one presses the toggle state button the state is printed correctly, but it stops being in bold as it is initially. This is an easy fix.

Make accepted codes an array

https://github.com/moxystudio/js-keyboard-only-outlines/blob/master/index.js#L6

This could be simply an array, where each entry could have a comment saying the key it is.
This would avoid the necessity of having to the Object.keys() on every keystroke.

Improve demo styles in lower resolutions

Perhaps add a min-width to the .container and allow the input row to wrap?