Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/csstools/postcss-focus-within
Use the :focus-within pseudo-selector in CSS
https://github.com/csstools/postcss-focus-within
Last synced: 8 days ago
JSON representation
Use the :focus-within pseudo-selector in CSS
- Host: GitHub
- URL: https://github.com/csstools/postcss-focus-within
- Owner: csstools
- License: cc0-1.0
- Archived: true
- Created: 2018-02-17T22:11:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-12-16T16:37:49.000Z (almost 3 years ago)
- Last Synced: 2024-04-14T05:31:41.328Z (7 months ago)
- Language: CSS
- Homepage: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-focus-within
- Size: 327 KB
- Stars: 30
- Watchers: 6
- Forks: 7
- 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 Within [
][postcss]
[
][npm-url]
[
][css-url]
[
][cli-url]
[
][git-url]
[PostCSS Focus Within] lets you use the `:focus-within` pseudo-class in CSS,
following the [Selectors Level 4 specification].
It is the companion to the [focus-within polyfill].
[](https://caniuse.com/#feat=css-focus-within)
```css
.my-form-field:focus-within label {
background-color: yellow;
}
/* becomes */
.my-form-field[focus-within] label {
background-color: yellow;
}
.my-form-field:focus-within label {
background-color: yellow;
}
```
[PostCSS Focus Within] duplicates rules using the `:focus-within` pseudo-class
with a `[focus-within]` attribute selector, the same selector used by the
[focus-within polyfill]. This replacement selector can be changed using the
`replaceWith` option. Also, the preservation of the original `:focus-within`
rule can be disabled using the `preserve` option.
## Usage
Add [PostCSS Focus Within] to your project:
```bash
npm install postcss postcss-focus-within --save-dev
```
Use [PostCSS Focus Within] to process your CSS:
```js
const postcssFocusWithin = require('postcss-focus-within');
postcssFocusWithin.process(YOUR_CSS /*, processOptions, pluginOptions */);
```
Or use it as a [PostCSS] plugin:
```js
const postcss = require('postcss');
const postcssFocusWithin = require('postcss-focus-within');
postcss([
postcssFocusWithin(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);
```
[PostCSS Focus Within] 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
focusWithin({ preserve: false });
```
```css
.my-form-field:focus-within label {
background-color: yellow;
}
/* becomes */
.my-form-field[focus-within] label {
background-color: yellow;
}
```
### replaceWith
The `replaceWith` option defines the selector to replace `:focus-within`. By
default, the replacement selector is `[focus-within]`.
```js
focusWithin({ replaceWith: '.focus-within' });
```
```css
.my-form-field:focus-within label {
background-color: yellow;
}
/* becomes */
.my-form-field.focus-within label {
background-color: yellow;
}
.my-form-field:focus-within label {
background-color: yellow;
}
```
[css-url]: https://cssdb.org/#focus-within-pseudo-class
[cli-url]: https://github.com/csstools/postcss-focus-within/actions/workflows/test.yml?query=workflow/test
[git-url]: https://gitter.im/postcss/postcss
[npm-url]: https://www.npmjs.com/package/postcss-focus-within
[focus-within polyfill]: https://github.com/jsxtools/focus-within
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
[PostCSS]: https://github.com/postcss/postcss
[PostCSS Focus Within]: https://github.com/csstools/postcss-focus-within
[PostCSS Loader]: https://github.com/postcss/postcss-loader
[Selectors Level 4 specification]: https://www.w3.org/TR/selectors-4/#the-focus-within-pseudo