Ravi Kumar Kempapura Srinivasa 63a73eab6f
Menu navigation: Improve flyout transition (#5367)
resolves #5160
2025-05-08 16:17:14 +02:00

545 lines
17 KiB
JavaScript

/*! Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
(function(Icinga, $) {
"use strict";
Icinga.Behaviors = Icinga.Behaviors || {};
try {
var d3 = require("icinga/icinga-php-thirdparty/mbostock/d3");
} catch (e) {
console.warn('D3.js library is unavailable. Navigation to flyout may not work as expected.');
}
var Navigation = function (icinga) {
Icinga.EventListener.call(this, icinga);
this.on('click', '#menu a', this.linkClicked, this);
this.on('click', '#menu tr[href]', this.linkClicked, this);
this.on('rendered', '#menu', this.onRendered, this);
if (typeof d3 !== "undefined") {
this.on('mousemove', '#menu .primary-nav .nav-level-1 > .nav-item', this.onMouseMove, this);
}
this.on('mouseenter', '#menu .primary-nav .nav-level-1 > .nav-item', this.onMouseEnter, this);
this.on('mouseleave', '#menu .primary-nav', this.hideFlyoutMenu, this);
this.on('click', '#toggle-sidebar', this.toggleSidebar, this);
this.on('click', '#menu .config-nav-item button', this.toggleConfigFlyout, this);
this.on('mouseenter', '#menu .config-menu .config-nav-item', this.showConfigFlyout, this);
this.on('mouseleave', '#menu .config-menu .config-nav-item', this.hideConfigFlyout, this);
this.on('keydown', '#menu .config-menu .config-nav-item', this.onKeyDown, this);
/**
* The DOM-Path of the active item
*
* @see getDomPath
*
* @type {null|Array}
*/
this.active = null;
/**
* Represents the extended flyout zone, an area formed by the previous cursor position, and top-left
* and bottom-left flyout points.
*
* @type {Array}
*/
this.extendedFlyoutZone = new Array(3);
/**
* Timer for managing the delay in showing a flyout on mouse movement.
*
* @type {null|number}
*/
this.flyoutTimer = null;
/**
* The menu
*
* @type {jQuery}
*/
this.$menu = null;
/**
* Local storage
*
* @type {Icinga.Storage}
*/
this.storage = Icinga.Storage.BehaviorStorage('navigation');
this.storage.setBackend(window.sessionStorage);
// Restore collapsed sidebar if necessary
if (this.storage.get('sidebar-collapsed')) {
$('#layout').addClass('sidebar-collapsed');
}
};
Navigation.prototype = new Icinga.EventListener();
/**
* Activate menu items if their class is set to active or if the current URL matches their link
*
* @param {Object} e Event
*/
Navigation.prototype.onRendered = function(e) {
var _this = e.data.self;
_this.$menu = $(e.target);
if (! _this.active) {
// There is no stored menu item, therefore it is assumed that this is the first rendering
// of the navigation after the page has been opened.
// initialise the menu selected by the backend as active.
var $active = _this.$menu.find('li.active');
if ($active.length) {
$active.each(function() {
_this.setActiveAndSelected($(this));
});
} else {
// if no item is marked as active, try to select the menu from the current URL
_this.setActiveAndSelectedByUrl($('#col1').data('icingaUrl'));
}
}
_this.refresh();
};
/**
* Re-render the menu selection according to the current state
*/
Navigation.prototype.refresh = function() {
// restore selection to current active element
if (this.active) {
var $el = $(this.icinga.utils.getElementByDomPath(this.active));
this.setActiveAndSelected($el);
/*
* Recreate the html content of the menu item to force the browser to update the layout, or else
* the link would only be visible as active after another click or page reload in Gecko and WebKit.
*
* fixes #7897
*/
if ($el.is('li')) {
$el.html($el.html());
}
}
};
/**
* Handle a link click in the menu
*
* @param event
*/
Navigation.prototype.linkClicked = function(event) {
var $a = $(this);
var href = $a.attr('href');
var _this = event.data.self;
var icinga = _this.icinga;
// Check for ctrl or cmd click to open new tab and don't unfold other menus
if (event.ctrlKey || event.metaKey) {
return false;
}
if (href.match(/#/)) {
// ...it may be a menu section without a dedicated link.
// Switch the active menu item:
_this.setActiveAndSelected($a);
} else {
_this.setActiveAndSelected($(event.target));
}
// update target url of the menu container to the clicked link
var $menu = $('#menu');
var menuDataUrl = icinga.utils.parseUrl($menu.data('icinga-url'));
menuDataUrl = icinga.utils.addUrlParams(menuDataUrl.path, { url: href });
$menu.data('icinga-url', menuDataUrl);
};
/**
* Activate a menu item based on the current URL
*
* Activate a menu item that is an exact match or fall back to items that match the base URL
*
* @param url {String} The url to match
*/
Navigation.prototype.setActiveAndSelectedByUrl = function(url) {
var $menu = $('#menu');
if (! $menu.length) {
return;
}
// try to active the first item that has an exact URL match
this.setActiveAndSelected($menu.find('[href="' + url + '"]'));
// the url may point to the search field, which must be activated too
if (! this.active) {
this.setActiveAndSelected($menu.find('form[action="' + this.icinga.utils.parseUrl(url).path + '"]'));
}
// some urls may have custom filters which won't match any menu item, in that case search
// for a menu item that points to the base action without any filters
if (! this.active) {
this.setActiveAndSelected($menu.find('[href="' + this.icinga.utils.parseUrl(url).path + '"]').first());
}
};
/**
* Try to select a new URL by
*
* @param url
*/
Navigation.prototype.trySetActiveAndSelectedByUrl = function(url) {
var active = this.active;
this.setActiveAndSelectedByUrl(url);
if (! this.active && active) {
this.setActiveAndSelected($(this.icinga.utils.getElementByDomPath(active)));
}
};
/**
* Remove all active elements
*/
Navigation.prototype.clear = function() {
if (this.$menu) {
this.$menu.find('.active').removeClass('active');
}
};
/**
* Remove all selected elements
*/
Navigation.prototype.clearSelected = function() {
if (this.$menu) {
this.$menu.find('.selected').removeClass('selected');
}
};
/**
* Select all menu items in the selector as active and unfold surrounding menus when necessary
*
* @param $item {jQuery} The jQuery selector
*/
Navigation.prototype.select = function($item) {
// support selecting the url of the menu entry
var $input = $item.find('input');
$item = $item.closest('li');
if ($item.length) {
// select the current item
var $selectedMenu = $item.addClass('active');
// unfold the containing menu
var $outerMenu = $selectedMenu.parent().closest('li');
if ($outerMenu.length) {
$outerMenu.addClass('active');
}
} else if ($input.length) {
$input.addClass('active');
}
};
Navigation.prototype.setActiveAndSelected = function ($el) {
if ($el.length > 1) {
$el.each((key, el) => {
if (! this.active) {
this.setActiveAndSelected($(el));
}
});
} else if ($el.length) {
let parent = $el[0].closest('.nav-level-1 > .nav-item, .config-menu');
if ($el[0].offsetHeight || $el[0].offsetWidth || parent.offsetHeight || parent.offsetWidth) {
// It's either a visible menu item or a config menu item
this.setActive($el);
this.setSelected($el);
}
}
};
/**
* Change the active menu element
*
* @param $el {jQuery} A selector pointing to the active element
*/
Navigation.prototype.setActive = function($el) {
this.clear();
this.select($el);
if ($el.closest('li')[0]) {
this.active = this.icinga.utils.getDomPath($el.closest('li')[0]);
} else if ($el.find('input')[0]) {
this.active = this.icinga.utils.getDomPath($el[0]);
} else {
this.active = null;
}
// TODO: push to history
};
Navigation.prototype.setSelected = function($el) {
this.clearSelected();
$el = $el.closest('li');
if ($el.length) {
$el.addClass('selected');
}
};
/**
* Reset the active element to nothing
*/
Navigation.prototype.resetActive = function() {
this.clear();
this.active = null;
};
/**
* Reset the selected element to nothing
*/
Navigation.prototype.resetSelected = function() {
this.clearSelected();
this.selected = null;
};
/**
* Captures the mouse enter events to the navigation item and show the flyout.
*
* @param e
*/
Navigation.prototype.onMouseEnter = function(e) {
const $layout = $('#layout');
const _this = e.data.self;
if ($layout.hasClass('minimal-layout')) {
return;
}
const $target = $(this);
if (
typeof d3 !== "undefined"
&& ! _this.extendedFlyoutZone.includes(undefined)
&& d3.polygonContains(_this.extendedFlyoutZone, [e.clientX, e.clientY])
) {
return;
}
if (! $target[0].matches(':has(.nav-level-2)')) {
$layout.removeClass('menu-hovered');
$target.siblings().not($target).removeClass('hover');
return;
}
if (! $target.is(':hover')) {
return;
}
$layout.addClass('menu-hovered');
_this.extendedFlyoutZone[0] = [e.clientX, e.clientY];
_this.showFlyoutMenu($target);
}
/**
* Captures the mouse move events within the navigation item
* and show the flyout if needed.
*
* @param e
*/
Navigation.prototype.onMouseMove = function(e) {
const _this = e.data.self;
clearTimeout(_this.flyoutTimer);
const $target = $(this);
if (! $target[0].matches(':has(.nav-level-2)')) {
return;
}
if (! $target.hasClass('hover')) {
if (
! _this.extendedFlyoutZone.includes(undefined)
&& d3.polygonContains(_this.extendedFlyoutZone, [e.clientX, e.clientY])
) {
_this.flyoutTimer = setTimeout(function() {
_this.showFlyoutMenu($target);
}, 200);
} else {
// The extended flyout zone keeps shrinking when the mouse moves towards the target's flyout.
// Hence, if the mouse is moved and stopped over a new target, sometimes it could be slightly outside
// the extended flyout zone. This in turn will not trigger the flyoutTimer.
// Hence, the showFlyoutMenu should be manually called.
_this.showFlyoutMenu($target);
}
}
_this.extendedFlyoutZone[0] = [e.clientX, e.clientY];
};
/**
* Show the fly-out menu for the given target navigation item
*
* @param $target
*/
Navigation.prototype.showFlyoutMenu = function($target) {
const $flyout = $target.find('.nav-level-2');
$target.siblings().not($target).removeClass('hover');
$target.addClass('hover');
const targetRect = $target[0].getBoundingClientRect();
const flyoutRect = $flyout[0].getBoundingClientRect();
const css = { "--caretY": "" };
if (targetRect.top + flyoutRect.height > window.innerHeight) {
css.top = targetRect.bottom - flyoutRect.height;
if (css.top < 10) {
css.top = 10;
// Not sure why -2, but it aligns the caret perfectly with the menu item
css["--caretY"] = `${targetRect.bottom - 10 - 2}px`;
}
$flyout.addClass('bottom-up');
} else {
$flyout.removeClass('bottom-up');
css.top = targetRect.top;
}
$flyout.css(css);
this.extendedFlyoutZone[1] = [flyoutRect.left, css.top];
this.extendedFlyoutZone[2] = [flyoutRect.left, css.top + flyoutRect.height];
};
/**
* Hide the fly-out menu
*
* @param e
*/
Navigation.prototype.hideFlyoutMenu = function(e) {
var $layout = $('#layout');
var $nav = $(e.currentTarget);
var $hovered = $nav.find('.nav-level-1 > .nav-item.hover');
const _this = e.data.self;
_this.extendedFlyoutZone.fill(undefined);
if (! $hovered.length) {
$layout.removeClass('menu-hovered');
return;
}
setTimeout(function() {
try {
if ($hovered.is(':hover') || $nav.is(':hover')) {
return;
}
} catch(e) { /* Bypass because if IE8 */ };
$hovered.removeClass('hover');
$layout.removeClass('menu-hovered');
}, 600);
};
/**
* Collapse or expand sidebar
*
* @param {Object} e Event
*/
Navigation.prototype.toggleSidebar = function(e) {
var _this = e.data.self;
var $layout = $('#layout');
$layout.toggleClass('sidebar-collapsed');
_this.storage.set('sidebar-collapsed', $layout.is('.sidebar-collapsed'));
$(window).trigger('resize');
};
/**
* Toggle config flyout visibility
*
* @param {Object} e Event
*/
Navigation.prototype.toggleConfigFlyout = function(e) {
var _this = e.data.self;
if ($('#layout').is('.config-flyout-open')) {
_this.hideConfigFlyout(e);
} else {
_this.showConfigFlyout(e);
}
}
/**
* Hide config flyout
*
* @param {Object} e Event
*/
Navigation.prototype.hideConfigFlyout = function(e) {
$('#layout').removeClass('config-flyout-open');
if (e.target) {
delete $(e.target).closest('.container')[0].dataset.suspendAutorefresh;
}
}
/**
* Show config flyout
*
* @param {Object} e Event
*/
Navigation.prototype.showConfigFlyout = function(e) {
$('#layout').addClass('config-flyout-open');
$(e.target).closest('.container')[0].dataset.suspendAutorefresh = '';
}
/**
* Hide, config flyout when "Enter" key is pressed to follow `.flyout` nav item link
*
* @param {Object} e Event
*/
Navigation.prototype.onKeyDown = function(e) {
var _this = e.data.self;
if (e.key == 'Enter' && $(document.activeElement).is('.flyout a')) {
_this.hideConfigFlyout(e);
}
}
/**
* Called when the history changes
*
* @param url The url of the new state
* @param data The active menu item of the new state
*/
Navigation.prototype.onPopState = function (url, data) {
// 1. get selection data and set active menu
if (data) {
var active = this.icinga.utils.getElementByDomPath(data);
if (!active) {
this.logger.fail(
'Could not restore active menu from history, path in DOM not found.',
data,
url
);
return;
}
this.setActiveAndSelected($(active))
} else {
this.resetActive();
this.resetSelected();
}
};
/**
* Called when the current state gets pushed onto the history, can return a value
* to be preserved as the current state
*
* @returns {null|Array} The currently active menu item
*/
Navigation.prototype.onPushState = function () {
return this.active;
};
Icinga.Behaviors.Navigation = Navigation;
})(Icinga, jQuery);