Skip to content

Files

Latest commit

7f1ca5f · Oct 24, 2024

History

History
This branch is 7 commits ahead of, 246 commits behind microsoft/rushstack:main.

loader-load-themed-styles

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Sep 19, 2023
Aug 14, 2024
Sep 26, 2023
Jul 26, 2024
Oct 24, 2024
Oct 24, 2024
Jun 28, 2017
Sep 28, 2022
Oct 24, 2024
Sep 19, 2023

@microsoft/loader-load-themed-styles

Installation

npm install @microsoft/loader-load-themed-styles --save-dev

Overview

This simple Webpack loader that wraps the loading of CSS in script equivalent to require("load-themed-styles").loadStyles( /* css text */ ). It is designed to be a replacement for style-loader.

Usage

Documentation: Using loaders

This loader is designed to be used in conjunction with css-loader.

var css = require("@microsoft/loader-load-themed-styles!css!./file.css");
// => returns css code from file.css, uses load-themed-styles to load the CSS on the page.

Example config

        use: [
          {
            loader: "@microsoft/loader-load-themed-styles",  // creates style nodes from JS strings
            options: {
              async: false
            }
          },
          {
            loader: "css-loader", // translates CSS into CommonJS
            options: {
              modules: true,
              importLoaders: 2,
              localIdentName: '[name]_[local]_[hash:base64:5]',
              minimize: false
            }
          },
          {
            loader: 'postcss-loader',
            options: {
              plugins: function () {
                return [
                  require('autoprefixer')
                ];
              }
            }
          },
          {
            loader: "sass-loader",
          }
        ]

Options

async (boolean, defaults to false)

By default, @microsoft/load-themed-styles loads styles synchronously. This can have adverse performance effects if many styles are loaded in quick succession. If the async option is set to true, the loadStyles function is called with the second parameter set to true, directing the function to debounce style loading causing fewer changes to the DOM.

Links

@microsoft/loader-load-themed-styles is part of the Rush Stack family of projects.