Skip to Content
Menu

networkAvailable()

Check (or set) the network availability (online/offline).

JavaScript February 7, 2021

Usage

JavaScript
nebula.networkAvailable(onload)

Parameters

onload
(Optional) (Boolean) True when this function is called on window load, use false otherwise
Default: None

Request or provide clarification »

Additional Notes

This function will add a body class of “offline” when the network is unavailable (and remove it when the network connection returns).

It is also called automatically when the network availability changes using the JavaScript events online and offline.

Was this page helpful? Yes No


    A feedback message is required to submit this form.


    Please check that you have entered a valid email address.

    Enter your email address if you would like a response.

    Thank you for your feedback!

    Source File

    Located in /assets/js/modules/utilities.js on line 849.

    No Hooks

    This function does not have any filters or actions available. Request one?
    JavaScript
    nebula.networkAvailable = function(){
        let onlineStatus = ( navigator.onLine )? 'online' : 'offline';
    
        nebula.dom.body.removeClass('offline');
        if ( onlineStatus === 'offline' ){
            nebula.dom.body.addClass('offline');
        }
    
        if ( 'localStorage' in window ){
            try {
                localStorage.setItem('network_connection', onlineStatus);
            } catch {
                //Ignore errors
            }
        }
    
        nebula.dom.document.trigger('nebula_network_change');
    };
    

    Override

    To override or disable this JavaScript function, simply redeclare it with the exact same function name. Remember: Some functionality is conditionally loaded via dynamic imports, so if your function is not overriding properly, try listening for a DOM event (described below).

    JavaScript

    For non-module import functions:

    nebula.networkAvailable = function(onload){
        //Write your own code here, leave it blank, or return false.
    }


    For dynamically imported module function overrides:

    jQuery(window).on('load', function(){
        nebula.networkAvailable = function(onload){
            //Write your own code here, leave it blank, or return false.
        }
    });


    Custom Nebula DOM events do also exist, so you could also try the following if the Window Load listener does not work:

    jQuery(document).on('nebula_module_loaded', function(module){
        //Note that the module variable is also available to know which module specifically was imported
        if ( typeof nebula.networkAvailable === 'function' ){
            nebula.networkAvailable = function(onload){
                //Write your own code here, leave it blank, or return false.
            }
    	}
    });