Socket
Socket
Sign inDemoInstall

defer-css

Package Overview
Dependencies
0
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    defer-css

ExtraSlim Javascript to Load css in your page without affecting load speed.


Version published
Maintainers
1
Install size
11.5 kB
Created

Readme

Source

Defer Css

Simple LightWeight functions to defer css in your web applications or websites.

Two functions and one object is set to global window

FunctionArgumentsUsage
deferCss(scripts=[], mountOnId='defer-css')For loading a style or array of styles
hasStyleSheet(search='', return=false)A bonus helper function for checking if the browser has loaded a particular stylesheet using document.styleSheets
if $return is "all" the CSSStyleSheet Object is returned, else if any string we assume its a key in the CSSStyleSheet object you are trying to get.
Direct Browser Installation
<!--Using JsDeliver CDN-->
<script src="https://cdn.jsdelivr.net/npm/defer-css"></script>

<!-- Or Using UnPkg CDN-->
<script src="https://unpkg.com/defer-css"></script>

<!-- Or Using Bundle.run-->
<script src="https://bundle.run/defer-css"></script>
From Package Managers

You can include using require or import but defer-css does not export anything.

It sets window.deferCss && window.deferCssData

Usage

Defined styles are loaded before the link element with defer-css id in your page

<html>
    <head>
        <!-- Styles will be placed before this link element-->
        <link id="defer-css"/>
    </head>
</html>

You can change this to your custom id

<head>
    <!-- Some Styles    -->
    <link href="....">
    <link href="....">
    <link href="....">
    
    <!-- Styles will be placed before this add-css-here element-->
    <link id="add-css-here"/>
</head>

Load Css using javascript

deferCss([
    'style-1.min.css',
    {href: 'style-2.min.css', crossorigin: 'anonymous'}
], 'add-css-here')

Adds the following styles

    <link rel="stylesheet" href="style-1.min.css" crossorigin="anonymous">
    <link rel="stylesheet" href="style-2.min.css" crossorigin="anonymous">

The values of the styles array can either be a url string or an object that will be used to build your link element

If the object includes an onload function, it is executed when the css file is loaded.

deferCss([
    {
        href: 'style-1.min.css', 
        onload: function() {
            // do something
        }
    },
])
Multiple deferCss

Lets say you want to mount css in multiple places.

<head>
    <link id="main-css">
    <style>
        .some-style-before-other-css{
            background: teal;
        }
    </style>
    <link id="other-css">
</head>
deferCss(['main-css-1.css', 'main-css-2.css'], 'main-css');
deferCss([
    {
        href: 'other-css-1.css',
        crossorigin: 'anonymous'
    },
    'other-css-2.css'
], 'other-css');

This will result to.
```html
    <link rel="stylesheet" href="main-css-1.css">
    <link rel="stylesheet" href="main-css-2.css">
    <style>
        .some-style-before-other-css{
            background: teal;
        }
    </style>
    <link rel="stylesheet" href="other-css-1.css">
    <link rel="stylesheet" href="other-css-2.css">
DeferCssData

The deferCssData includes details you may need.

{
    // Element mounted on, default = 'defer-css'
    'defer-css': {
        total: Number, // total number of css defined
        loaded: Number // total number of css loaded (at the moment)
    }
}
Example
<!doctype html>
<html lang="en">
<head>
    <!-- Required meta tags -->
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <title>Defer Css Test</title>
    <!--    <script src="https://cdn.jsdelivr.net/npm/defer-css"></script>-->
    <script src="./index.js"></script>
    <style>
        /* Show Nothing until bootstrap arrives.*/
        .empty {
            display: none;
        }
    </style>
    <link id="add-css-here"/>
</head>
<body>

<div class="container empty d-block">
    <div class="row">
        <div class="col-md-6 offset-md-3">
            <div class="card shadow" style="margin-top: 20vh">
                <div class="card-body text-center">
                    <h1>Hello, world!</h1>
                    <h5 class="text-primary">
                        Bootstrap Loaded with defer-css
                    </h5>
                </div>
            </div>
        </div>
    </div>
</div>

<script>
    let scripts = [
        'https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css',
        // Style with onload
        {
            href: './app.css',
            onload: function () {
                console.log(this.href + ' Style Loaded!');
                // value of deferCssData
                console.log(deferCssData);
            }
        },
    ];

    // Defer scripts
    deferCss(scripts, 'add-css-here');
</script>
</body>
</html>

FAQs

Last updated on 11 Apr 2019

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc