diff options
| author | littleblack111 <littleblack11111@gmail.com> | 2023-10-14 15:05:55 +0800 |
|---|---|---|
| committer | littleblack111 <littleblack11111@gmail.com> | 2023-10-14 15:05:55 +0800 |
| commit | c06f7ee0a40255214c477e13d9b956a7e07c2900 (patch) | |
| tree | f5982a568ef8fab865d0142e71c7494fea3e4c1b /node_modules/postcss-focus-within/README.md | |
| parent | 3fd9400d4dccc25aa29b5702216732e0b7542073 (diff) | |
postcss,(plugins): nanocss, postcss-preset-env
Diffstat (limited to 'node_modules/postcss-focus-within/README.md')
| -rw-r--r-- | node_modules/postcss-focus-within/README.md | 205 |
1 files changed, 205 insertions, 0 deletions
diff --git a/node_modules/postcss-focus-within/README.md b/node_modules/postcss-focus-within/README.md new file mode 100644 index 00000000..72423177 --- /dev/null +++ b/node_modules/postcss-focus-within/README.md @@ -0,0 +1,205 @@ +# PostCSS Focus Within [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">][PostCSS] + +[<img alt="npm version" src="https://img.shields.io/npm/v/postcss-focus-within.svg" height="20">][npm-url] [<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/focus-within-pseudo-class.svg" height="20">][css-url] [<img alt="Build Status" src="https://github.com/csstools/postcss-plugins/workflows/test/badge.svg" height="20">][cli-url] [<img alt="Discord" src="https://shields.io/badge/Discord-5865F2?logo=discord&logoColor=white">][discord] + +[PostCSS Focus Within] lets you use the `:focus-within` pseudo-class in CSS, +following the [Selectors Level 4 specification]. + +To use this feature you need to do two things : +- add the [PostCSS plugin](#usage) that transforms the selector into a class or attribute +- add the [browser polyfill](#browser) that sets the attribute or class on elements in a browser + +```pcss +.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: + +```bash +npm install postcss postcss-focus-within --save-dev +``` + +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) +- [PostCSS Load Config](INSTALL.md#postcss-load-config) +- [Webpack](INSTALL.md#webpack) +- [Next.js](INSTALL.md#nextjs) +- [Gulp](INSTALL.md#gulp) +- [Grunt](INSTALL.md#grunt) + +## Options + +### preserve + +The `preserve` option determines whether the original notation +is preserved. By default, it is preserved. + +```js +postcssFocusWithin({ preserve: false }) +``` + +```pcss +.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. + +```js +postcssFocusWithin({ replaceWith: '.focus-within' }); +``` + +```pcss +.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. + +```js +postcssFocusWithin({ disablePolyfillReadyClass: true }) +``` + +```pcss +.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; +} +``` + +## Browser + +```js +import focusWithinInit from 'postcss-focus-within/browser'; + +focusWithinInit(); +``` + +or + +```html +<!-- When using a CDN url you will have to manually update the version number --> +<script src="https://unpkg.com/postcss-focus-within@8.0.0/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. + +```js +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`. + +```js +focusWithinInit({ replaceWith: '.focus-within }); +``` + +This option should be used if it was changed at PostCSS configuration level. + +### Using with Next.js + +Given that Next.js imports packages both on the browser and on the server, you need to make sure that the package is only imported on the browser. + +As outlined in the [Next.js documentation](https://nextjs.org/docs/advanced-features/dynamic-import#with-external-libraries), you need to load the package with a dynamic import: + +```jsx +useEffect(async () => { + const focusWithinInit = (await import('postcss-focus-within/browser')).default; + focusWithinInit(); +}, []); +``` + +[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test +[css-url]: https://cssdb.org/#focus-within-pseudo-class +[discord]: https://discord.gg/bUadyRwkJS +[npm-url]: https://www.npmjs.com/package/postcss-focus-within + +[PostCSS]: https://github.com/postcss/postcss +[PostCSS Focus Within]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-focus-within +[Selectors Level 4 specification]: https://www.w3.org/TR/selectors-4/#the-focus-within-pseudo |
