jsincss-has-selector
Version:
A :has() selector plugin for jsincss
101 lines (65 loc) • 3.45 kB
Markdown
# jsincss-has-selector
A :has() selector plugin for [jsincss](https://github.com/tomhodgins/jsincss)
## About
This plugin is a JavaScript module that works with [JS-in-CSS stylesheets](https://responsive.style/theory/what-is-a-jic-stylesheet.html), to emulate the CSS `:has()` selector, for selecting elements that contain an element matching a selector.
## Downloading
You can download jsincss-has-selector and add it to your codebase manually, or download it with npm:
```bash
npm install jsincss-has-selector
```
Another option that works for building or testing, that isn't ideal for production use, is linking to the module directly from a CDN like unpkg:
```html
<script type=module>
import has from 'https://unpkg.com/jsincss-has-selector/index.vanilla.js'
</script>
```
## Importing
This plugin exists in three different formats:
- CommonJS module: [index.js](index.js)
- Vanilla JS module: [index.vanilla.js](index.vanilla.js)
- Browser function: [index.browser.js](index.browser.js)
You can import this plugin using the native [`import`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) statement in JavaScript. Here you can assign any name you want to the function you are importing, and you only need to provide a path to the plugin's `index.vanilla.js` file:
```js
import has from './index.vanilla.js'
```
You can also use the CommonJS-formatted module located at [index.js](index.js) with `require()` for use with bundlers that don't use vanilla JS modules.
Once you have imported this plugin into your module, you can use the plugin as `has()`
## Using JS-in-CSS Stylesheets
The main goal of this plugin is to allow CSS authors the ability to emulate the behaviour of the `:has()` selector from CSS, to select elements containing element(s) matching another selector.
The plugin has the following format:
```js
has(selector, child, rule)
```
- `selector` is a string containing a CSS selector
- `child` is a string containing a CSS selector for matching a child
- `rule` is a string or template string containing a CSS rule
## Example
This example will use the `jsincss` plugin to load a JS-in-CSS stylesheet making use of this plugin. To test it in a JavaScript module, import both the `jsincss` package and any helper plugins you want:
```html
<script type=module>
import jsincss from 'https://unpkg.com/jsincss/index.vanilla.js'
import has from 'https://unpkg.com/jsincss-has-selector/index.vanilla.js'
jsincss(() => `
${has('*', ':scope > li', `
border: 1px solid red;
`)}
`)
</script>
```
It's also possible to write your stylesheets as a separate JavaScript module like this, where you import any helper plugins at the top of the stylesheet:
```js
import has from 'https://unpkg.com/jsincss-has-selector/index.vanilla.js'
export default () => `
${has('*', ':scope > li', `
border: 1px solid red;
`)}
`
```
And then import both the `jsincss` plugin and the stylesheet into your code and run them like this, suppling any `selector` or `events` list the `jsincss` plugin might need to apply the stylesheet only the the element(s) and event(s) you require, depending on what you're doing:
```js
import jsincss from 'https://unpkg.com/jsincss/index.vanilla.js'
import stylesheet from './path/to/stylesheet.js'
jsincss(stylesheet)
```
## Compatible JS-in-CSS Stylesheet Loaders
- [jsincss](https://github.com/tomhodgins/jsincss)