admin_toolbar 3.6.0

New minor release of project's 3.x development branch introducing new features, bug fixes and maintenance tasks, but mostly containing the following changes:

How to update? Requires running database updates (drush updb) which make changes to the active configurations of the module.

What's in this release?

Maintenance tasks:

Clean-up of the code base (fixing GitLab CI validation jobs), update of JS libraries (Vanilla and ESLINT), compatibility fixes with supported Core versions, improved automated Tests coverage.

Bug fixes:

Compatibility with Project Browser, CSS and JS fixes.

New features: What's new?

Improved module's configuration settings forms with additional help texts, description and simpler field labels.
Added menu tabs (local tasks) allowing to navigate easily through the different modules settings forms.

Admin Toolbar: See changes at: /admin/config/user-interface/admin-toolbar

New setting: Toolbar sticky behavior
Allows changing the default behavior of the toolbar so it doesn't follow the browser window on scroll and stays "stuck" at the top of the page (disabled).
Take a look at the intermediate version with a smooth slide in/out animation of the toolbar with the option: Disabled, show on scroll-up:
Scrolling down will hide the toolbar and scrolling up will show it.

Additionally, there is an option to force the toolbar to be displayed or hidden, with a button (expand/collapse) in the toolbar and the keyboard shortcut Alt + p.

All the styles of these behaviors and components could be overridden/extended using CSS, in particular, the slide in/out animation could easily be replaced with any other type of effect, transition or parameters, such as fade in/out, bounce, swing, etc...

New setting: Toolbar hoverIntent behavior
This setting was moved out of the Admin Toolbar Tools settings form to the Admin Toolbar's and a new option was added to control the timeout of the hoverIntent library in milliseconds. It is now possible to give more or less time to a user before a menu dropdown closes after the mouse moves out. In other words, lower values will give a "rougher" experience with the dropdown menu closing very quickly (instantly), or a "smoother" experience with greater values giving the ability to move the mouse slowly and imprecisely while still keeping the menu dropdown open.
 

Admin Toolbar Search: See changes at: /admin/config/user-interface/admin-toolbar-search

New setting: Search focus keyboard shortcut: Alt + a
It is now possible to immediately focus (jump to) the Admin Toolbar Search input field by pressing the keyboard combination of keys: Alt + a

If any of the added keyboard shortcuts (Alt + a / Alt + p) enter in conflict with any already defined shortcut combinations, then it is recommended to disable the corresponding settings for now, until the shortcuts could be made configurable, see #3087173: Allow shortcut keys to be configurable.

Breaking changes:

The following changes are part of the reason why this new release was added as a new minor version (3.6.x), since they introduce backward compatibility (BC) breaking changes:

Important: The module does not support anymore the implementation of a __construct method for any class extending class ExtraLinks, see issue #3514075.
In other words, if any class extends module's ExtraLinks class and implements its own __construct method, the site will crash after upgrade.
The issue above explains what would be the required code changes to fix these types of errors.

Important: Support for older versions of the Project Browser module has been dropped: Please upgrade to the latest version or at least the 2.x branch.
If the Project Browser 1.x module is installed in your project and you upgrade Admin Toolbar, without upgrading Project Browser, your site will crash.

Minor: Some string translations may have been broken since the form labels, descriptions, textual elements in general were changed. To be clear: some texts in module's forms may not be translated in your languages anymore since the updated strings have not yet been translated.

Please help us keep module's translations up to date: Localize Admin Toolbar, then click on your language and submit your translations.
 

Contributors (19)

dydave, ressa, andresalvarez, ericmulder1980, sascha_meissner, grevil, thomas.frobieter, chhavi.sharma, tirupati_singh, aaron.ferris, darkdim, bwaindwain, benstallings, ankondrat4, giannis makantasis, connbi, silvi.addweb, prashant.c, japerry

Changelog

Issues: 25 issues resolved.

Changes since 3.5.3:

Bug

• #3408119 by prashant.c: Set min and max values for "Maximum number of bundle sub-menus to display".
• #3506824 by dydave: Fixed compatibility with Project Browser following the latest changes to the its routes.
• #3452561 by bwaindwain, dydave: Reverted changes from 'Hide the navigation menu on mobile' causing conflicts with default toolbar behavior.
• #3436637 by giannis makantasis, dydave, connbi: Fixed CSS style for active toolbar menu links arrow disappearing.

Feature

• #3304810 by dydave, sascha_meissner, grevil, thomas.frobieter, ressa: Added configuration setting to enable button and shorcut 'Alt+p' to show/hide toolbar.
• #3519815 by dydave, tirupati_singh, ressa: Added menu tabs (local tasks) for Admin Toolbar Settings forms.
• #3494646 by dydave, ressa: Added keyboard shortcut 'Alt + a' to focus Admin Toolbar Search field.
• #3440852 by dydave, ressa, aaron.ferris: Added configurable hoverIntent 'timeout' setting.
• #3509584 by dydave, ressa, darkdim: Added toolbar sticky behavior setting to 'Hide on scroll-down, show on scroll-up'.
• #3514574 by ankondrat4, dydave: Improved Admin Toolbar Tools 'Flush CSS and Javascript' operation (method 'flushJsCss()') to fully invalidate JS/CSS caches and regenerate aggregated files.
• #3255672 by dydave, ressa, silvi.addweb, japerry: Added configuration setting to enable/disable sticky/fixed toolbar behavior.

Task

• #3487246 by dydave, ericmulder1980: Warn site owners about the removal of Admin Toolbar Links Access Filter.
• #3524284 by dydave: Removed file 'CHANGELOG.txt'.
• #3523066 by chhavi.sharma, dydave, ressa: Updated Admin Toolbar Search settings page path to remove trailing '-settings'.
• #3522548 by ressa, dydave: Increased color contrast of search result links and updated search field placeholder label to include shortcut.
• #3520680 by ressa, dydave: Improved Admin Toolbar settings form page by adding basic help text and moving around fields or options.
• #3522518 by dydave: Removed file 'LICENSE.TXT' from module's code base.
• #3519967 by dydave: Added initial Functional Tests for the 'AdminToolbarSearchSettingsForm'.
• #3518123 by dydave: Refactored method 'flushJsCss' with 'backwardsCompatibleCall' to support deprecated '_drupal_flush_css_js' for versions below core:10.2.
• #3516995 by dydave, ressa: Moved the 'hoverintent_functionality' setting out of 'admin_toolbar_tools' to 'admin_toolbar'.
• #3517506 by dydave: PHPSTAN: Raised validation level from 0 (min) to 6.
• #3514075 by benstallings, dydave: Fixed PHPSTAN validation error 'Unsafe usage of new static()'.
• #3514774 by dydave: Added basic PHPUNIT Tests coverage for 'admin_toolbar_tools' menu links and 'ToolbarController' class.
• #3513588 by andresalvarez, dydave: Updated the 'jquery-hoverIntent' JS library from 'v1.8.1' to 'v1.10.2'.
• #3512602 by andresalvarez, dydave: Fixed PHPSTAN (next minor) validation errors.