An overflow-detecting plugin for jsincss
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
LICENSE
README.md
index.browser.js
index.js
index.vanilla.js
package.json

README.md

jsincss-overflow

An overflow-detecting plugin for jsincss

About

This plugin is a JavaScript module that works with JS-in-CSS stylesheets, to apply styles to an element based on whether it is overflowed or not.

Downloading

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

npm install jsincss-overflow

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 overflow from 'https://unpkg.com/jsincss-overflow/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 overflow 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 overflow()

Using JS-in-CSS Stylesheets

The main goal of this plugin is to allow stylesheet authors to target elements based on whether their content is overflowed on one or more edges.

The plugin has the following format:

overflow(selector, options, stylesheet)
  • selector is a string containing a CSS selector
  • options is a string containing one, or an array containing multiple of the following keywords: top, right, bottom, left
  • stylesheet is a string or template string containing a CSS stylesheet, where :self is a selector that can be used to target the element(s) that pass the test

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 overflow from 'https://unpkg.com/jsincss-overflow/index.vanilla.js'

  jsincss(() => `

    ${overflow('textarea', 'top', `
      :self {
        background: lime;
      }
    `)}

  `, 'textarea', ['scroll'])
</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 overflow from 'https://unpkg.com/jsincss-overflow/index.vanilla.js'

export default () => `

  ${overflow('textarea', 'top', `
    :self {
      background: lime;
    }
  `)}

`

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)
jsincss(stylesheet, 'textarea', ['scroll'])

Compatible JS-in-CSS Stylesheet Loaders