Skip to content

Backend: focus search field when pressing forwardslash - '/' #27674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 9, 2020
Merged

Backend: focus search field when pressing forwardslash - '/' #27674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
73106d4
Focus search field when pressing '/'
vovayatsyuk Apr 9, 2020
b445058
Merge branch '2.4-develop' into feature-backend-search-hotkey
vovayatsyuk Sep 23, 2020
a17053a
Use keyCode const to check if forward slash was pressed
vovayatsyuk Sep 23, 2020
d033021
Rename 'e' into 'event'
vovayatsyuk Sep 23, 2020
5021e2b
Merge branch '2.4-develop' into feature-backend-search-hotkey
vovayatsyuk Oct 23, 2020
0d002e3
Unfinished test. Not sure how to check element's css visibility.
vovayatsyuk Oct 23, 2020
a93afde
Fixed invalid test. Now it checks if parent element has active class.
vovayatsyuk Oct 24, 2020
50d421d
Use namespaced event listener, to make it removable
vovayatsyuk Oct 26, 2020
3a19dca
Don't use whole jquery/ui when widget is needed only
vovayatsyuk Oct 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions app/code/Magento/Backend/Test/Mftf/Section/AdminHeaderSection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
<section name="AdminHeaderSection">
<element name="pageTitle" type="text" selector=".page-header h1.page-title"/>
<element name="adminUserAccountText" type="text" selector=".page-header .admin-user-account-text" />
<element name="globalSearchInput" type="text" selector="#search-global" />
<element name="globalSearchInputVisible" type="text" selector=".search-global-field._active #search-global" />
<!-- Legacy heading section. Mostly used for admin 404 and 403 pages -->
<element name="pageHeading" type="text" selector=".page-content .page-heading"/>
<!-- Used for page not found error -->
Expand Down
34 changes: 34 additions & 0 deletions app/code/Magento/Backend/Test/Mftf/Test/AdminSearchHotkeyTest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
-->

<tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
<test name="AdminSearchHotkeyTest">
<annotations>
<features value="Backend"/>
<stories value="Search form hotkey in backend"/>
<title value="Admin should be able focus on the search field with a hotkey"/>
<description value="Admin should be able focus on the search field with a hotkey - forwardslash"/>
<severity value="MINOR"/>
<group value="backend"/>
<group value="search"/>
</annotations>
<before>
<actionGroup ref="AdminLoginActionGroup" stepKey="LoginAsAdmin"/>
</before>
<after>
<actionGroup ref="AdminLogoutActionGroup" stepKey="logout"/>
</after>

<pressKey selector="body" parameterArray="[/]" stepKey="pressForwardslashKey"/>
<seeElement selector="{{AdminHeaderSection.globalSearchInputVisible}}" stepKey="seeActiveGlobalSearchInput"/>
<seeInField userInput="" selector="{{AdminHeaderSection.globalSearchInput}}" stepKey="seeEmptyGlobalSearchInput"/>
<pressKey selector="{{AdminHeaderSection.globalSearchInput}}" parameterArray="[/]" stepKey="pressForwardslashKeyAgain"/>
<seeInField userInput="/" selector="{{AdminHeaderSection.globalSearchInput}}" stepKey="seeForwardSlashInGlobalSearchInput"/>
</test>
</tests>
1 change: 1 addition & 0 deletions app/code/Magento/Ui/view/base/web/js/lib/key-codes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ define([], function () {
17: 'ctrlKey',
18: 'altKey',
16: 'shiftKey',
191: 'forwardSlashKey',
66: 'bKey',
73: 'iKey',
85: 'uKey'
Expand Down
24 changes: 22 additions & 2 deletions app/design/adminhtml/Magento/backend/web/js/theme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,8 +312,9 @@ define('globalNavigation', [

define('globalSearch', [
'jquery',
'jquery/ui'
], function ($) {
'Magento_Ui/js/lib/key-codes',
'jquery-ui-modules/widget'
], function ($, keyCodes) {
'use strict';

$.widget('mage.globalSearch', {
Expand Down Expand Up @@ -345,6 +346,25 @@ define('globalSearch', [
this.input.on('focus.activateGlobalSearchForm', function () {
self.field.addClass(self.options.fieldActiveClass);
});

$(document).on('keydown.activateGlobalSearchForm', function (event) {
var inputs = [
'input',
'select',
'textarea'
];

if (keyCodes[event.which] !== 'forwardSlashKey' ||
inputs.indexOf(event.target.tagName.toLowerCase()) !== -1 ||
event.target.isContentEditable
) {
return;
}

event.preventDefault();

self.input.focus();
});
}
});

Expand Down