source: frontend/node_modules/postcss-focus-visible/README.md

Last change on this file was 9af201e, checked in by MBK <marija.karapandzova@…>, 11 days ago

Fix frontend appearance

  • Property mode set to 100644
File size: 3.7 KB
Line 
1# PostCSS Focus Visible [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">][postcss]
2
3[<img alt="npm version" src="https://img.shields.io/npm/v/postcss-focus-visible.svg" height="20">][npm-url]
4[<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/focus-within-pseudo-class.svg" height="20">][css-url]
5[<img alt="Build Status" src="https://github.com/csstools/postcss-plugins/workflows/test/badge.svg" height="20">][cli-url]
6[<img alt="Discord" src="https://shields.io/badge/Discord-5865F2?logo=discord&logoColor=white">][discord]
7
8[PostCSS Focus Visible] lets you use the `:focus-visible` pseudo-class in
9CSS, following the [Selectors Level 4 specification].
10
11It is the companion to the [focus-visible polyfill].
12
13[!['Can I use' table](https://caniuse.bitsofco.de/image/css-focus-visible.png)](https://caniuse.com/#feat=css-focus-visible)
14
15```css
16:focus:not(:focus-visible) {
17 outline: none;
18}
19
20/* becomes */
21
22:focus:not(.focus-visible) {
23 outline: none;
24}
25
26:focus:not(:focus-visible) {
27 outline: none;
28}
29```
30
31[PostCSS Focus Visible] duplicates rules using the `:focus-visible` pseudo-class
32with a `.focus-visible` class selector, the same selector used by the
33[focus-visible polyfill]. This replacement selector can be changed using the
34`replaceWith` option. Also, the preservation of the original `:focus-visible`
35rule can be disabled using the `preserve` option.
36
37## Usage
38
39Add [PostCSS Focus Visible] to your project:
40
41```bash
42npm install postcss-focus-visible --save-dev
43```
44
45Use [PostCSS Focus Visible] to process your CSS:
46
47```js
48const postcssFocusVisible = require('postcss-focus-visible');
49
50postcssFocusVisible.process(YOUR_CSS /*, processOptions, pluginOptions */);
51```
52
53Or use it as a [PostCSS] plugin:
54
55```js
56const postcss = require('postcss');
57const postcssFocusVisible = require('postcss-focus-visible');
58
59postcss([
60 postcssFocusVisible(/* pluginOptions */)
61]).process(YOUR_CSS /*, processOptions */);
62```
63
64[PostCSS Focus Visible] runs in all Node environments, with special
65instructions for:
66
67| [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) |
68| --- | --- | --- | --- | --- | --- |
69
70## Options
71
72### preserve
73
74The `preserve` option defines whether the original selector should remain. By
75default, the original selector is preserved.
76
77```js
78focusVisible({ preserve: false });
79```
80
81```css
82:focus:not(:focus-visible) {
83 outline: none;
84}
85
86/* becomes */
87
88:focus:not(.focus-visible) {
89 outline: none;
90}
91```
92
93### replaceWith
94
95The `replaceWith` option defines the selector to replace `:focus-visible`. By
96default, the replacement selector is `.focus-visible`.
97
98```js
99focusVisible({ replaceWith: '[focus-visible]' });
100```
101
102```css
103:focus:not(:focus-visible) {
104 outline: none;
105}
106
107/* becomes */
108
109:focus:not([focus-visible]) {
110 outline: none;
111}
112
113:focus:not(:focus-visible) {
114 outline: none;
115}
116```
117
118[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
119[css-url]: https://cssdb.org/#focus-visible-pseudo-class
120[discord]: https://discord.gg/bUadyRwkJS
121[npm-url]: https://www.npmjs.com/package/postcss-focus-visible
122
123[focus-visible polyfill]: https://github.com/WICG/focus-visible
124[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
125[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
126[PostCSS]: https://github.com/postcss/postcss
127[PostCSS Focus Visible]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-focus-visible
128[PostCSS Loader]: https://github.com/postcss/postcss-loader
129[Selectors Level 4 specification]: https://www.w3.org/TR/selectors-4/#the-focus-visible-pseudo
Note: See TracBrowser for help on using the repository browser.