Skip to content

A jsincss plugin that lets you select elements to style using XPath selectors

License

Notifications You must be signed in to change notification settings

tomhodgins/jsincss-xpath-selector

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jsincss-xpath-selector

An XPath selector plugin for jsincss that lets you select elements to style using XPath selectors.

About

This plugin is a JavaScript module that works with JS-in-CSS stylesheets, to apply styles to an element in an HTML document based on an XPath selector.

Downloading

You can download jsincss-xpath-selector and add it to your codebase manually, or download it with npm:

npm install jsincss-xpath-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:

<script type=module>
  import xpath from 'https://unpkg.com/jsincss-xpath-selector/index.vanilla.js'
</script>

Importing

This plugin exists in three different formats:

You can import this plugin using the native 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:

import xpath from './index.vanilla.js'

You can also use the CommonJS-formatted module located at 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 xpath()

Using JS-in-CSS Stylesheets

The main goal of this plugin is to allow CSS authors the ability to use XPath selectors to select elements and apply a CSS rule to them.

The plugin has the following format:

xpath(selector, rule)
  • selector is a string containing an XPath selector
  • 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:

<script type=module>
  import jsincss from 'https://unpkg.com/jsincss/index.vanilla.js'
  import xpath from 'https://unpkg.com/jsincss-xpath-selector/index.vanilla.js'

  jsincss(() => `

    ${xpath('//*', `
      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:

import xpath from 'https://unpkg.com/jsincss-xpath-selector/index.vanilla.js'

export default () => `

  ${xpath('//*', `
    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:

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

About

A jsincss plugin that lets you select elements to style using XPath selectors

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published