Based on the proposed CSS
:focus-visible
pseudo-selector,
this prototype adds a focus-visible
class to the focused element,
in situations in which the :focus-visible
pseudo-selector should match.
- Read the Explainer.
- Read the Spec.
- Try the Demo.
- Give feedback!
npm install --save focus-visible
We recommend only using versions of the polyfill that have been published to npm, rather than cloning the repo and using the source directly. This helps ensure the version you're using is stable and thoroughly tested.
If you do want to build from source, make sure you clone the latest tag!
...
<script src="/node_modules/focus-visible/dist/focus-visible.min.js"></script>
</body>
</html>
We suggest that users
selectively disable the default focus style
by selecting for the case when the polyfill is loaded
and .focus-visible
is not applied to the element:
/*
This will hide the focus indicator if the element receives focus via the mouse,
but it will still show up on keyboard focus.
*/
.js-focus-visible :focus:not(.focus-visible) {
outline: none;
}
If there are elements which should always have a focus ring shown,
authors may explicitly add the focus-visible
class.
If explicitly added, it will not be removed on blur
.
The script uses two heuristics to determine whether the keyboard is being used:
- a
focus
event immediately following akeydown
event where the key pressed was eitherTab
,Shift + Tab
, or an arrow key. - focus moves into an element which requires keyboard interaction, such as a text field
- TODO: ideally, we also trigger keyboard modality following a keyboard event which activates an element or causes a mutation; this still needs to be implemented.
The :focus-visible
polyfill uses the
Element.classList API which is
not supported in IE 8-9. In accordance with the W3C's new Polyfill
guidance, the
:focus-visible
polyfill does not bundle other polyfills. If you need to support these older browsers
you should add the classList polyfill to your page
before loading the :focus-visible
polyfill. Using a service like
Polyfill.io will handle feature detecting and loading the necessary
polyfills for you.
Until all browsers ship :focus-visible
developers will need to use it defensively to avoid accidentally
removing focus styles in legacy browsers. This is easy to do with the polyfill.
/*
This will hide the focus indicator if the element receives focus via the mouse,
but it will still show up on keyboard focus.
*/
.js-focus-visible :focus:not(.focus-visible) {
outline: none;
}
/*
Optionally: Define a strong focus indicator for keyboard focus.
If you choose to skip this step then the browser's default focus
indicator will be displayed instead.
*/
.js-focus-visible .focus-visible {
…
}
As explained by the Paciello Group, developers who don't use the polyfill can still defensively rely on :focus-visible
using the
following snippet:
/*
Provide basic, default focus styles.
*/
button:focus {
…
}
/*
Remove default focus styles for mouse users ONLY if
:focus-visible is supported on this platform.
*/
button:focus:not(:focus-visible) {
…
}
/*
Optionally: If :focus-visible is supported on this
platform, provide enhanced focus styles for keyboard
focus.
*/
button:focus-visible {
…
}
In the future, when all browsers support :focus-visible
, the
snippets above will be unnecessary. But until that time it's important
to be mindful when you use :focus-visible
and to ensure you always
have a fallback strategy.