Usage
nebula.focusOnElement(element)
Parameters
element
(Required) (Object) The element to focus on
Default: None
Parameter Notes
If the element desired to be focused on is not typically focusable, this function makes it temporarily focusable.
Examples
Scroll to an element and then set tab navigability to start there as well.
jQuery('html, body').animate({
scrollTop: Math.floor(jQuery(scrollElement).offset().top-offset+pOffset)
}, scrollSpeed, function(){
nebula.focusOnElement(scrollElement); //Start tab navigability here too
});
Source File
Located in /assets/js/modules/utilities.js on line 219.
No Hooks
This function does not have any filters or actions available. Request one?nebula.focusOnElement = function(element = false){
if ( !element ){
nebula.help('nebula.focusOnElement() requires an element as a string or jQuery object.', '/functions/focusonelement/');
return;
}
//Debounce this because several things could call this simultaneously that cannot be reduced (like hashchange + scrollTo function call)
nebula.debounce(function(){
if ( typeof element === 'string' ){
element = jQuery.find(element); //Use find here to prevent arbitrary JS execution
} else if ( !element.jquery ){ //Check if it is already a jQuery object
element = jQuery(element);
}
//If the element is not focusable itself, add tabindex to make focusable and remove again
if ( !element.is(':focusable') ){ //Uses custom expression defined at the bottom of this file
element.attr('tabindex', -1).on('blur focusout', function(){
jQuery(this).removeAttr('tabindex');
});
}
element.trigger('focus'); //Focus on the element
}, 500, 'focusing on element', true);
};
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).
For non-module import functions:
nebula.focusOnElement = function(element){
//Write your own code here, leave it blank, or return false.
}
For dynamically imported module function overrides:
jQuery(window).on('load', function(){
nebula.focusOnElement = function(element){
//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.focusOnElement === 'function' ){
nebula.focusOnElement = function(element){
//Write your own code here, leave it blank, or return false.
}
}
});