https://github.com/jonathantneal/postcss-focus-visible

Use the :focus-visible pseudo-selector in CSS
https://github.com/jonathantneal/postcss-focus-visible

Last synced: about 1 month ago
JSON representation

Use the :focus-visible pseudo-selector in CSS

• Host: GitHub
• URL: https://github.com/jonathantneal/postcss-focus-visible
• Owner: csstools
• License: cc0-1.0
• Archived: true
• Created: 2017-05-22T23:20:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-12-16T16:35:49.000Z (almost 3 years ago)
• Last Synced: 2024-04-14T05:31:41.211Z (5 months ago)
• Language: CSS
• Homepage: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-focus-visible
• Size: 85 KB
• Stars: 53
• Watchers: 5
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
⚠️ PostCSS Focus Visible was moved to @csstools/postcss-plugins. ⚠️ 


Read the announcement



# PostCSS Focus Visible [][postcss]

[][npm-url]

[][css-url]

[][cli-url]

[][git-url]

[PostCSS Focus Visible] lets you use the `:focus-visible` pseudo-class in

CSS, following the [Selectors Level 4 specification].

It is the companion to the [focus-visible polyfill].

[!['Can I use' table](https://caniuse.bitsofco.de/image/css-focus-visible.png)](https://caniuse.com/#feat=css-focus-visible)

```css

:focus:not(:focus-visible) {

  outline: none;

}

/* becomes */

:focus:not(.focus-visible) {

  outline: none;

}

:focus:not(:focus-visible) {

  outline: none;

}

```

[PostCSS Focus Visible] duplicates rules using the `:focus-visible` pseudo-class

with a `.focus-visible` class selector, the same selector used by the

[focus-visible polyfill]. This replacement selector can be changed using the

`replaceWith` option. Also, the preservation of the original `:focus-visible`

rule can be disabled using the `preserve` option.

## Usage

Add [PostCSS Focus Visible] to your project:

```bash

npm install postcss-focus-visible --save-dev

```

Use [PostCSS Focus Visible] to process your CSS:

```js

const postcssFocusVisible = require('postcss-focus-visible');

postcssFocusVisible.process(YOUR_CSS /*, processOptions, pluginOptions */);

```

Or use it as a [PostCSS] plugin:

```js

const postcss = require('postcss');

const postcssFocusVisible = require('postcss-focus-visible');

postcss([

  postcssFocusVisible(/* pluginOptions */)

]).process(YOUR_CSS /*, processOptions */);

```

[PostCSS Focus Visible] runs in all Node environments, with special

instructions for:

| [Node](INSTALL.md#node) | [PostCSS CLI](INSTALL.md#postcss-cli) | [Webpack](INSTALL.md#webpack) | [Create React App](INSTALL.md#create-react-app) | [Gulp](INSTALL.md#gulp) | [Grunt](INSTALL.md#grunt) |

| --- | --- | --- | --- | --- | --- |

## Options

### preserve

The `preserve` option defines whether the original selector should remain. By

default, the original selector is preserved.

```js

focusVisible({ preserve: false });

```

```css

:focus:not(:focus-visible) {

  outline: none;

}

/* becomes */

:focus:not(.focus-visible) {

  outline: none;

}

```

### replaceWith

The `replaceWith` option defines the selector to replace `:focus-visible`. By

default, the replacement selector is `.focus-visible`.

```js

focusVisible({ replaceWith: '[focus-visible]' });

```

```css

:focus:not(:focus-visible) {

  outline: none;

}

/* becomes */

:focus:not([focus-visible]) {

  outline: none;

}

:focus:not(:focus-visible) {

  outline: none;

}

```

[cli-url]: https://github.com/csstools/postcss-focus-visible/actions/workflows/test.yml?query=workflow/test

[css-url]: https://cssdb.org/#focus-visible-pseudo-class

[git-url]: https://gitter.im/postcss/postcss

[npm-url]: https://www.npmjs.com/package/postcss-focus-visible

[focus-visible polyfill]: https://github.com/WICG/focus-visible

[Gulp PostCSS]: https://github.com/postcss/gulp-postcss

[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss

[PostCSS]: https://github.com/postcss/postcss

[PostCSS Focus Visible]: https://github.com/csstools/postcss-focus-visible

[PostCSS Loader]: https://github.com/postcss/postcss-loader

[Selectors Level 4 specification]: https://www.w3.org/TR/selectors-4/#the-focus-visible-pseudo