https://github.com/tomhodgins/jsincss-protocol-sniffer
A protocol sniffer plugin for jsincss
https://github.com/tomhodgins/jsincss-protocol-sniffer
at-rules css css-selector js-in-css jsincss protocol selector-resolver
Last synced: 6 months ago
JSON representation
A protocol sniffer plugin for jsincss
- Host: GitHub
- URL: https://github.com/tomhodgins/jsincss-protocol-sniffer
- Owner: tomhodgins
- License: mit
- Created: 2018-01-28T02:09:21.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-24T20:57:17.000Z (over 7 years ago)
- Last Synced: 2025-09-30T15:41:51.623Z (10 months ago)
- Topics: at-rules, css, css-selector, js-in-css, jsincss, protocol, selector-resolver
- Language: JavaScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jsincss-protocol-sniffer
A protocol sniffer 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 apply styles based on the protocol currently in use.
## Downloading
You can download jsincss-protocol-sniffer and add it to your codebase manually, or download it with npm:
```bash
npm install jsincss-protocol-sniffer
```
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
import protocol from 'https://unpkg.com/jsincss-protocol-sniffer/index.vanilla.js'
```
## 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 protocol 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 `protocol()`
## Using JS-in-CSS Stylesheets
The main goal of this plugin is to allow CSS authors the ability to target different styles based on the current protocol currently being used to access the web page (`file`, `http`, and `https` are supported).
The plugin has the following format:
```js
protocol(options, stylesheet)
```
- `options` is an array containing strings of the protocols where you want the styles to apply
- `stylesheet` is a string or template string containing a CSS stylesheet
## 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
import jsincss from 'https://unpkg.com/jsincss/index.vanilla.js'
import protocol from 'https://unpkg.com/jsincss-protocol-sniffer/index.vanilla.js'
jsincss(() => `
${protocol(['file'],`
body:before {
content: "You're on FILE://";
}
`)}
${protocol(['http'],`
body:before {
content: "You're on HTTP://"
}
`)}
${protocol(['https'],`
body:before {
content: "You're on HTTPS://"
}
`)}
`)
```
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 protocol from 'https://unpkg.com/jsincss-protocol-sniffer/index.vanilla.js'
export default () => `
${protocol(['file'],`
body:before {
content: "You're on FILE://";
}
`)}
${protocol(['http'],`
body:before {
content: "You're on HTTP://"
}
`)}
${protocol(['https'],`
body:before {
content: "You're on HTTPS://"
}
`)}
`
```
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)