style-outline

Style Outline


Keywords
style outline, javascript, css
License
MIT
Install
npm install style-outline@1.1.0

Documentation

Style Outline

Debug your CSS layers easily.

build status npm version npm downloads

Installation

To install the stable version:

npm install --save-dev style-outline

This assumes you are using npm as your package manager.
If you don't, you can access these files on unpkg, download them, or point your package manager to them.

If you don't use a module bundler, it's also fine. The style-outline npm package includes precompiled production and development UMD builds in the dist folder. They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. For example, you can drop a UMD build as a <script> tag on the page. The UMD builds make Style Outline available as a window.StyleOutline global variable.

window.StyleOutline.default();

The Style Outline source code is written in ES2015 but it is precompiled both CommonJS and UMD builds to ES5 so they work in any modern browser.

Note that unlike Style Outline itself, packages in the Style Outline ecosystem don't provide UMD builds, so it is recommended using CommonJS module bundlers like Webpack and Browserify for the most comfortable development experience.

Gist

The only thing you need is to invoke outline function when page is loaded.

import outline from 'style-outline';

outline();

That's it!

Change Log

This project adheres to Semantic Versioning. Every release is documented on the GitHub Releases page.

License

MIT