Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@moxy/keyboard-only-outlines

1.0.5 • Public • Published

keyboard-only-outlines

NPM version Downloads Build Status Coverage Status Dependency status Dev Dependency status

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.

Install

npm i @moxy/keyboard-only-outlines

DownloadsWeekly Downloads

600

Version

1.0.5

License

MIT

Unpacked Size

11.8 kB

Total Files

6

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar