Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

postcss-focus-within

Package Overview
Dependencies
1
Maintainers
2
Versions
12
Issues
File Explorer

Advanced tools

postcss-focus-within

Use the :focus-within pseudo-selector in CSS

    6.1.1latest

Version published
Maintainers
2
Weekly downloads
6,781,970
decreased by-9.98%

Weekly downloads

Readme

Source

PostCSS Focus Within PostCSS Logo

npm version CSS Standard Status Build Status Discord

PostCSS Focus Within lets you use the :focus-within pseudo-class in CSS, following the Selectors Level 4 specification.

.my-form-field:focus-within label { background-color: yellow; } /* becomes */ .my-form-field[focus-within].js-focus-within label, .js-focus-within .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:

npm install postcss postcss-focus-within --save-dev

Use it as a PostCSS plugin:

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:

NodePostCSS CLIWebpackCreate React AppGulpGrunt

Options

preserve

The preserve option determines whether the original notation is preserved. By default, it is preserved.

postcssFocusWithin({ preserve: false }) .my-form-field:focus-within label { background-color: yellow; } /* becomes */ .my-form-field[focus-within].js-focus-within label, .js-focus-within .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]. Please note that using a class, leverages classList under the hood which might not be supported on some old browsers such as IE9, so you may need to polyfill classList in those cases.

postcssFocusWithin({ replaceWith: '.focus-within' }); .my-form-field:focus-within label { background-color: yellow; } /* becomes */ .my-form-field.focus-within.js-focus-within label, .js-focus-within .my-form-field.focus-within label { background-color: yellow; } .my-form-field:focus-within label { background-color: yellow; }

Note that changing this option implies that it needs to be passed to the browser polyfill as well.

disablePolyfillReadyClass

The disablePolyfillReadyClass option determines if selectors are prefixed with an indicator class. This class is only set on your document if the polyfill loads and is needed.

By default this option is false. Set this to true to prevent the class from being added.

postcssFocusWithin({ disablePolyfillReadyClass: true }) .my-form-field:focus-within label { background-color: yellow; } /* becomes */ .my-form-field[focus-within] label, .my-form-field[focus-within] label { background-color: yellow; } .my-form-field:focus-within label { background-color: yellow; }

Browser

import focusWithinInit from 'postcss-focus-within/browser'; focusWithinInit();

or

<!-- When using a CDN url you will have to manually update the version number --> <script src="https://unpkg.com/[email protected]/dist/browser-global.js"></script> <script>focusWithinInit()</script>

PostCSS Focus Within works in all major browsers, including Safari 6+ and Internet Explorer 9+ without any additional polyfills.

Browser Usage

force

The force option determines whether the library runs even if the browser supports the selector or not. By default, it won't run if the browser does support the selector.

focusWithinInit({ force: true });
replaceWith

Similar to the option for the PostCSS Plugin, replaceWith determines the attribute or class to apply to an element when it's considered to be :focus-within.

focusWithinInit({ replaceWith: '.focus-within });

This option should be used if it was changed at PostCSS configuration level.

Keywords

FAQs

What is postcss-focus-within?

Use the :focus-within pseudo-selector in CSS

Is postcss-focus-within popular?

The npm package postcss-focus-within receives a total of 6,411,932 weekly downloads. As such, postcss-focus-within popularity was classified as popular.

Is postcss-focus-within well maintained?

We found that postcss-focus-within demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 2 open source maintainers collaborating on the project.

Last updated on 23 Aug 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc