Skip to content

Disable outlines caused by navigation methods other than keyboard

License

Notifications You must be signed in to change notification settings

moxystudio/react-keyboard-only-outlines

Repository files navigation

react-keyboard-only-outlines

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

A component that enables keyboard-only-outlines so that outlines are only visible when using the keyboard.

Installation

$ npm install @moxy/react-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

You should use this component just once in your project:

import KeyboardOnlyOutlines from '@moxy/react-keyboard-only-outlines';

<KeyboardOnlyOutlines>
    <MyApp />
</KeyboardOnlyOutlines>

Props

name type default description
stylesheetTarget DOM Node See keyboard-only-outlines The DOM node where to insert the stylesheet with styles to disable the outlines
styles string See keyboard-only-outlines The styles to apply when a focus event is caused by mouse navigation

Tests

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

License

Released under the MIT License.