async-stylesheet-webpack-plugin
Advanced tools
Referencing CSS stylesheets with link[rel=stylesheet] or @import causes browsers to delay page rendering while a stylesheet loads. When loading stylesheets that are not critical to the initial rendering of a page, this blocking behavior is undesirable. The new <link rel="preload"> standard enables us to load stylesheets asynchronously, without blocking rendering.
npm install --save-dev async-stylesheet-webpack-plugin
The plugin will update all your webpack bundles stylesheets in the head using link tags with rel="preload" attribute.
Just add the plugin to your webpack config as follows:
webpack.config.js
const HtmlWebpackPlugin = require('html-webpack-plugin')
const AsyncStylesheetWebpackPlugin = require('async-stylesheet-webpack-plugin');
module.exports = {
...
plugins: [
new HtmlWebpackPlugin(),
new AsyncStylesheetWebpackPlugin(),
...
]
}
This will generate a file dist/index.html containing the following:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Webpack App</title>
<link href="app.css" rel="preload" as="style" onload="this.onload=null;this.rel='stylesheet';">
<noscript><link href="app.css" rel="stylesheet"></noscript>
</head>
<body>
<script src="app.js"></script>
</body>
</html>
You can pass a hash of configuration options to async-stylesheet-webpack-plugin. Allowed values are as follows:
| Name | Type | Default | Description |
|---|---|---|---|
preloadPolyfill | {Boolean} | false | If true then enabled legacy browser support |
noscriptFallback | {Boolean} | true | If true then enabled fallback stylesheets loading without JavaScript |
chunks | {String[]} | null | Allows you to async load only some chunks |
excludeChunks | {String[]} | null | Allows you to skip async load some chunks |
Here's an example webpack config illustrating how to use these options:
webpack.config.js
module.exports = {
...
plugins: [
new HtmlWebpackPlugin(),
new AsyncStylesheetWebpackPlugin({
preloadPolyfill: true,
noscriptFallback: true
}),
...
]
}
If preloadPolyfill option is enabled (this option disabled by default) async-stylesheet-webpack-plugin adding in HTML head cssrelpreload.js provided by loadCSS.
This will generate a file dist/index.html containing the following:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Webpack App</title>
<script type="text/javascript">/* here is the content of the cssrelpreload.js */</script>
<link href="app.css" rel="preload" as="style" onload="this.onload=null;this.rel='stylesheet';">
<noscript><link href="app.css" rel="stylesheet"></noscript>
</head>
<body>
<script src="app.js"></script>
</body>
</html>
If noscriptFallback option is enabled (this option enabled by default) async-stylesheet-webpack-plugin adding in HTML head noscript tag with traditional stylesheet loading.
This will generate a file dist/index.html containing the following:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Webpack App</title>
<link href="app.css" rel="preload" as="style" onload="this.onload=null;this.rel='stylesheet';">
<noscript><link href="app.css" rel="stylesheet"></noscript>
</head>
<body>
<script src="app.js"></script>
</body>
</html>
If noscriptFallback option is disabled async-stylesheet-webpack-plugin only updated link tags:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Webpack App</title>
<link href="app.css" rel="preload" as="style" onload="this.onload=null;this.rel='stylesheet';">
</head>
<body>
<script src="app.js"></script>
</body>
</html>
Welcome to issues!
FAQs
Loading stylesheets asynchronously
The npm package async-stylesheet-webpack-plugin receives a total of 419 weekly downloads. As such, async-stylesheet-webpack-plugin popularity was classified as not popular.
We found that async-stylesheet-webpack-plugin demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.