Skip to content
This repository has been archived by the owner on Sep 4, 2024. It is now read-only.
/ criticalcss Public archive

Package to generate critical css via a configuration file

Notifications You must be signed in to change notification settings

weprovide/criticalcss

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IODigital_CriticalCss

Warning

This module is deprecated. Use @iodigital/criticalcss instead.


This node module makes it possible to generate critical css bundles from different pages in different viewports. It is based on GitHub - addyosmani/critical: Extract & Inline Critical-path CSS in HTML pages

Install

npm install iodigital-criticalcss

Usage

Configuration

First add a configuration file in the root of your project , named: criticalcss.config.json . This configuration should contain your urls and dimensions for the viewport. Example configuration:

{
    "domain": "https://site.com",
    "renderWaitTime": 2500,
    "pages": [
        {
            "src": "/",
            "target": "app/design/frontend/THEMEPATH/THEMEPATH/web/css/cms-critical.css"
        },
        {
            "src": "/category/",
            "target": "app/design/frontend/THEMEPATH/THEMEPATH/web/css/category-critical.css"
        },
        {
            "src": "/PDP.html",
            "target": "app/design/frontend/THEMEPATH/THEMEPATH/web/css/product-critical.css"
        },
        {
            "src": "/checkout/#shipping",
            "target": "app/design/frontend/THEMEPATH/THEMEPATH/web/css/checkout-critical.css"
        }
    ],
    "dimensions": [
        { "width": 320 }, // Height is optional
        { "width": 767, "height": 3000 },
        { "width": 992 },
        { "width": 1200 },
        { "width": 1424 }
    ]
}

In the pages array, src is the page you want critical css from and target is the place to drop the newly generated critical css bundle. Dimensions only require widths (this differs per project). The height will be chosen based on a set of most used resolutions:

const standardViewports = [
    { width: 1920, height: 1080 },
    { width: 414, height: 896 },
    { width: 1536, height: 864 },
    { width: 1366, height: 768 },
    { width: 375, height: 667 },
    { width: 360, height: 640 },
];

If you want to explicitly use a set height, you may add it to the dimensions array like this (it will overwrite the default):

"dimensions": [
       ...
        { "width": 767, "height": 3000 },
      ...
    ]

Running it

To use this package, you need to run: npx iodigital-criticalcss in the command line.

Using environment variables

There are some environment variables that can be used while generating the criticalcss.

Available environment variables
  • DOMAIN: When domain is set, this will be used to render criticalcss for.
  • CRITICALCSS_CONFIG_FILE: You can alter the criticalcss configuration file that will be used, can be useful when deploying to more than one environment.
How to use environment variables
export DOMAIN=https://www.google.com
npx iodigital-criticalcss

or

DOMAIN=https://www.google.com npx iodigital-criticalcss

About

Package to generate critical css via a configuration file

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published