vue-style-loader

What is vue-style-loader?

The vue-style-loader is an npm package that is designed to work with Vue.js single-file components. It allows for the injection of component-scoped CSS into the document's head section dynamically. This loader can handle hot module replacement (HMR) during development, which means styles can be updated without refreshing the entire page. It also supports server-side rendering (SSR) for Vue applications.

What are vue-style-loader's main functionalities?

CSS Injection

Injects CSS into the document's head section. The code sample shows how to chain vue-style-loader with css-loader to process and add a CSS file to a Vue component.

require('vue-style-loader!css-loader!./styles.css');

Hot Module Replacement (HMR)

Supports HMR, allowing styles to be updated in real-time during development without a full page reload. The code sample demonstrates how to set up HMR for a CSS file within a Vue component.

if (module.hot) {
  module.hot.accept('./styles.css', function() {
    require('vue-style-loader!css-loader!./styles.css');
  });
}

Server-Side Rendering (SSR) Support

vue-style-loader can be used in server-side rendering setups to inject styles when rendering Vue components on the server. The code sample shows a basic server setup that renders a Vue application to a string.

const createApp = require('/path/to/built-server-bundle.js');
server.get('*', (req, res) => {
  const context = { url: req.url };
  createApp(context).then(app => {
    renderer.renderToString(app, (err, html) => {
      if (err) {
        if (err.code === 404) {
          res.status(404).end('Page not found');
        } else {
          res.status(500).end('Internal Server Error');
        }
      } else {
        res.end(html);
      }
    });
  });
});

Other packages similar to vue-style-loader

style-loader

style-loader is a webpack loader that injects CSS into the DOM using multiple <style> tags. It is similar to vue-style-loader but is not scoped to Vue.js components and does not have built-in SSR support.

mini-css-extract-plugin

This webpack plugin extracts CSS into separate files. It creates a CSS file per JS file which contains CSS. It is different from vue-style-loader as it generates external CSS files instead of injecting styles into the DOM.

isomorphic-style-loader

isomorphic-style-loader is designed for isomorphic (universal) web apps. It extends style-loader to work with server-side rendering, similar to vue-style-loader's SSR support, but it is not specific to Vue.js.

README

vue-style-loader

This is a fork based on style-loader. Similar to style-loader, you can chain it after css-loader to dynamically inject CSS into the document as style tags. However, since this is included as a dependency and used by default in vue-loader, in most cases you don't need to configure this loader yourself.

Options

• manualInject (3.1.0+):

  Type: boolean. When importing the style from a non-vue-file, by default the style is injected as a side effect of the import. When manualInject is true, the imported style object exposes a __inject__ method, which can then be called manually at appropriate timing. If called on the server, the method expects one argument which is the ssrContext to attach styles to.

  import styles from 'styles.scss'
  
  export default {
    beforeCreate() { // or create a mixin for this purpose
      if(styles.__inject__) {
        styles.__inject__(this.$ssrContext)
      }
    }
  
    render() {
      return <div class={styles.heading}>Hello World</div>
    }
  }
  

  Note this behavior is enabled automatically when vue-style-loader is used on styles imported within a *.vue file. The option is only exposed for advanced usage.

• ssrId (3.1.0+):

  Type: boolean. Add data-vue-ssr-id attribute to injected <style> tags even when not in Node.js. This can be used with pre-rendering (instead of SSR) to avoid duplicate style injection on hydration.

Differences from style-loader

Server-Side Rendering Support

When bundling with target: 'node', the styles in all rendered components are collected and exposed on the Vue render context object as context.styles, which you can simply inline into your markup's <head>. If you are building a Vue SSR app, you probably should use this loader for CSS imported from JavaScript files too.

Misc

• Does not support url mode and reference counting mode. Also removed singleton and insertAt query options. It always automatically pick the style insertion mechanism that makes most sense. If you need these capabilities you should probably use the original style-loader instead.

• Fixed the issue that root-relative URLs are interpreted against chrome:// urls and make source map URLs work for injected <style> tags in Chrome.

License

MIT

Changelog

4.1.3 (2021-03-03)

Bug Fixes

• also support passed ES modules from css-loader in addition to CommonJS format (#47) (8b584bd)
• es module interop in HMR code (8bc2fe3)

<a name="4.1.2"></a>