Skip to Content
Menu

vibrate()

Vibrate supported devices with custom patterns.

JavaScript February 7, 2021

Usage

JavaScript
nebula.vibrate(pattern)

Parameters

pattern
(Optional) (Array) An array of integers denoting on/off vibration time in milliseconds
Default: [100, 200, 100, 100, 75, 25, 100, 200, 100, 500, 100, 200, 100, 500]

Parameter Notes

The pattern alternates starting with on.

Request or provide clarification »

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 731.

    No Hooks

    This function does not have any filters or actions available. Request one?
    JavaScript
    nebula.vibrate = function(pattern){
        if ( typeof pattern !== 'object' ){
            pattern = [100, 200, 100, 100, 75, 25, 100, 200, 100, 500, 100, 200, 100, 500];
        }
    
        if ( navigator.vibrate || navigator.webkitVibrate || navigator.mozVibrate || navigator.msVibrate ){
            navigator.vibrate(pattern);
        }
    
        return false;
    };
    

    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.vibrate = function(pattern){
        //Write your own code here, leave it blank, or return false.
    }


    For dynamically imported module function overrides:

    jQuery(window).on('load', function(){
        nebula.vibrate = function(pattern){
            //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.vibrate === 'function' ){
            nebula.vibrate = function(pattern){
                //Write your own code here, leave it blank, or return false.
            }
    	}
    });