Files
iTop/js/components/popover-menu.js
Molkobain 8334b68285 Popover menu: Introduce option to add a visual hint on the menu toggler
This adds a visual hint (caret down) on the toggler to help the user understand that clicking on the toggler won't do something right away, but will open a menu instead
2021-03-19 19:50:50 +01:00

123 lines
2.9 KiB
JavaScript

/*
* Copyright (C) 2013-2021 Combodo SARL
*
* This file is part of iTop.
*
* iTop is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* iTop is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
*/
;
$(function()
{
// the widget definition, where 'itop' is the namespace,
// 'popover-menu' the widget name
$.widget( 'itop.popover_menu',
{
// default options
options:
{
toggler: '',
},
css_classes:
{
opened: 'ibo-is-opened',
},
js_selectors:
{
menu: '[data-role="ibo-popover-menu"]',
section: '[data-role="ibo-popover-menu--section"]',
item: '[data-role="ibo-popover-menu--item"]',
},
// the constructor
_create: function () {
this._bindEvents();
this._closePopup();
if (true === this.options.add_visual_hint_to_toggler) {
this._addVisualHintToToggler();
}
},
// events bound via _bind are removed automatically
// revert other modifications here
_destroy: function () {
},
_bindEvents: function () {
const me = this;
const oBodyElem = $('body');
this.element.find(this.js_selectors.item).on('click', function (oEvent) {
me._closePopup();
});
// Mostly for outside clicks that should close elements
oBodyElem.on('click', function (oEvent) {
me._onBodyClick(oEvent);
});
},
// Events callbacks
_onBodyClick: function (oEvent) {
if ($(oEvent.target.closest(this.js_selectors.menu)).length === 0 && $(oEvent.target.closest(this.options.toggler)).length === 0) {
this._closePopup();
}
},
// Methods
/**
* Add a visual hint (caret) on the toggler
*
* @return {boolean}
* @private
*/
_addVisualHintToToggler: function () {
if ('' === this.options.toggler) {
return false;
}
const oTogglerElem = $(this.options.toggler);
if (oTogglerElem.length === 0) {
return false;
}
oTogglerElem.append($(`<span class="ibo-popover-menu--toggler-visual-hint"><span class="fas fa-caret-down"></span></span>`));
return true;
},
_openPopup: function () {
this.element.addClass(this.css_classes.opened);
},
_closePopup: function () {
this.element.removeClass(this.css_classes.opened);
},
openPopup: function () {
this._openPopup();
},
closePopup: function()
{
this._closePopup();
},
togglePopup: function()
{
if(this.element.hasClass(this.css_classes.opened))
{
this._closePopup();
}
else
{
this._openPopup();
}
},
});
});