Skip to content

Latest commit

 

History

History
108 lines (68 loc) · 3.29 KB

README.md

File metadata and controls

108 lines (68 loc) · 3.29 KB

jsincss-element-units

An element unit plugin for jsincss

About

This plugin is a JavaScript module that works with JS-in-CSS stylesheets, to use element-percentage units as values for any property in CSS.

Downloading

You can download index.js and add it to your codebase, or download it with npm:

npm install jsincss-element-units

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 eunit from 'https://unpkg.com/jsincss-element-units/index.js'
</script>

Importing

You can import the plugin into your own JavaScript modules in a couple of ways.

The first way is 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.js file:

import eunit from './node_modules/jsincss-element-units/index.js'

If you want to use require to load this plugin instead, and use a bundler like Webpack or Parcel, make sure to add .default as you require it:

const eunit = require('jsincss-element-units').default

Once you have imported this plugin into your module, you can use the plugin as eunit()

Using JS-in-CSS Stylesheets

The main goal of this plugin is to allow CSS authors the ability to use units based on a percentage of the width or height of an element. Similar to the viewport-percentage units (vw, vh, vmin, and vmax) these units are called ew, eh, emin, and emax.

The plugin has the following format:

eunit(selector, rule)
  • selector is a string containing a CSS selector
  • rule is a string or template string containing a CSS rule, that can include ew, eh, emin, and emax units

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.js'
  import eunit from 'https://unpkg.com/jsincss-element-units/index.js'

  jsincss(() => {

    return `

      ${eunit('h1', `
        font-size: 10ew;
      `)}

    `

  })
</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 eunit from 'http://unpkg.com/jsincss-element-units/index.js'

export default () => {

  return `

    ${eunit('h1', `
      font-size: 10ew;
    `)}

  `

}

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.js'
import stylesheet from './path/to/stylesheet.js'

jsincss(stylesheet)

Compatible JS-in-CSS Stylesheet Loaders