Critical extracts & inlines critical-path (above-the-fold) CSS from HTML
$ npm install --save critical
- Gulp users should use Critical directly
- Optimize a basic page with Gulp with a tutorial
- Optimize an Angular boilerplate with Gulp
- Optimize a Weather app with Gulp
var critical = ;
Generate and inline critical-path CSS
Generate critical-path CSS
Generate and minify critical-path CSS:
Generate and return output via a callback:
Generate critical-path CSS with multiple resolutions
When your site is adaptive and you want to deliver critical CSS for multiple screen resolutions this is a useful option. note: (your final output will be minified as to eliminate duplicate rule inclusion)
<style> / critical CSS from generation
Minify and inline stylesheets:
Inline and return output via a callback:
||Base directory in which the source and destination are to be written|
||HTML source to be operated against. This option takes precedence over the
||Location of the HTML source to be operated against|
||Location of where to save the output of an operation|
||(Generation only) Width of the target viewport|
||(Generation only) Height of the target viewport|
||(Generation only) an array of objects containing height and width.|
||Enable minification of CSS output|
||Remove the inlined styles from any stylesheets referenced in the HTML. It generates new references based on extracted content so it's safe to use for multiple HTML files referencing the same stylesheet|
||Inline images (default: false)|
||Sets a max file size (in bytes) for base64 inlined images|
critical works well with standard input.
$ cat test/fixture/index.html | critical --base test/fixture > critical.css
You can also pass in the critical CSS file as an option.
$ critical test/fixture/index.html --base test/fixture > critical.css
Why is critical-path CSS important?
Why should critical-path CSS be inlined?
For best performance, you may want to consider inlining the critical CSS directly into the HTML document. This eliminates additional roundtrips in the critical path and if done correctly can be used to deliver a “one roundtrip” critical path length where only the HTML is a blocking resource.
Are there any sample projects available using Critical?
Why, yes!. Take a look at this Gulp project which demonstrates using Critical to generate and inline critical-path CSS. It also includes a mini-tutorial that walks through how to use it in a simple webapp.
When should I just use Penthouse directly?
The main differences between Critical and Penthouse, a module we use, are:
- Critical will automatically extract stylesheets from your HTML from which to generate critical-path CSS from, whilst other modules generally require you to specify this upfront.
- Critical provides methods for inlining critical-path CSS (a common logical next-step once your CSS is generated)
- Since we tackle both generation and inlining, we're able to abstract away some of the ugly boilerplate otherwise involved in tackling these problems separately.
That said, if your site or app has a large number of styles or styles which are being dynamically injected into the DOM (sometimes common in Angular apps) I recommend using Penthouse directly. It will require you to supply styles upfront, but this may provide a higher level of accuracy if you find Critical isn't serving your needs.
What other alternatives to Critical are available?
Is Critical stable and suitable for production use?
Many of the current tools around critical-path CSS are in an experimental stage and are constantly striving to improve. The same could be said of Critical. It hasn't been extensively tested on a ton of sites and it's very possible something may well break. That said, we welcome you to try it out on your project and report bugs if you find them.
Can I contribute?
Of course. We appreciate all of our contributors and welcome contributions to improve the project further. If you're uncertain whether an addition should be made, feel free to open up an issue and we can discuss it.
Apache-2.0 © Addy Osmani