npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

constructable-style-loader

v1.0.0-alpha.8

Published

Loading only needed selectors of a given CSS library into web component as a constructable stylesheet.

Downloads

24

Readme

constructable-style-loader

Apply CSS directly to a DOM element as a constructable stylesheet. Constructable-style-loader creates CSSStyleSheetObject JavaScript object, which can be adopted to an element using adoptedStyleSheets setter.

It can be optionally chained with postcss-loader when need to use output from other CSS preprocessors. If used with postcss-loader, then also consider postcss-discard-comments plugin to delete unnecessary comments that would bloat the bundle and potentially have invalid characters that can break the parser.

Getting Started

To begin, install constructable-style-loader:

npm install --save-dev constructable-style-loader

Then add the loader to your webpack config. For example:

style.css

.panel {
  background-color: orange;
  border-style: solid;
}

panel.js

import style from './style.css';

class Panel extends HTMLElement {
    constructor() {
        super();

        this.attachShadow({mode: "open"});
        this.shadowRoot.innerHTML = `<div class="panel">Panel CMP</div>`;
        this.shadowRoot.adoptedStyleSheets = [style]
    }
}

if (customElements.get('ata-panel') == null) {
    customElements.define('ata-panel', Panel);
}

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.css$/i,
        use: ['constructable-style-loader'],
      },
    ],
  },
};

Optional usage with purgecss

Loader options accept object that will be passed to purgecss plugin (assuming it is installed), if {purge: true} property is present.

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.css$/i,
        use: [
            {
                loader: 'constructable-style-loader',
                options: {
                    purge: true,
                    content: ['**/*.js'],
                    safelist: ['white-listed']
                }
            },
        ]
      },
    ],
  },
};

If constructable-style-loader is chained after post-loader, purgecss will be given AST root from PostCSS to avoid duplicate parsing of CSS string.

Note about performance

In case of web components, creating a separate CSS tree per component ended up being unnecessary. Browser does not appear to be duplicating CSS tree in every place where it is applied the way inserting tag in every shadow root would, but only points to it. On the contrary, having separate CSS tree per component only expanded bundle size. Could potentially investigate if there are any performance wins if CSSStyleSheetObjects are created at runtime, not compile time.