README

Magento 2 module that allows you to quickly search for configuration paths in the Magento back-office using a keyboard shortcut.

Description

This module adds a quick search feature for Magento 2 configuration paths (as they appear in the core_config_data table). It allows administrators to quickly find a configuration setting by typing part of its path.

Features

Quick Search: Opens a search box with a configurable keyboard shortcut
Autocomplete: Displays configuration path suggestions in real-time
Direct Navigation: Click on a result to go directly to the configuration section
macOS Compatibility: Automatically uses the Command key (⌘) on macOS instead of Ctrl
Configurable Shortcut: The shortcut key and modifier can be customized
Enable/Disable: The module can be enabled or disabled from the configuration

Requirements

Magento 2.4.x
PHP 8.1 or higher

Installation

Manual Installation

Create the module directory:
```
mkdir -p app/code/Xguenel/ConfigSearch
```
Copy the module files to this directory

Enable the module:

bin/magento module:enable Xguenel_ConfigSearch

Update the database and recompile:

bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush

Configuration

Access the module configuration via:

Stores > Configuration > Xguenel Extensions > Config Search

Available Options

Option	Description	Default Value
Enable Module	Enables or disables the module	Yes
Shortcut Key	Key to open the search (with modifier)	K
Modifier Key	Keyboard modifier (Ctrl or Shift + Ctrl)	Ctrl

Modifier Options

Option	Windows/Linux	macOS
Ctrl	`Ctrl + [key]`	`⌘ + [key]`
Shift + Ctrl	`Shift + Ctrl + [key]`	`Shift + ⌘ + [key]`

Usage

Default Keyboard Shortcut

Action	Windows/Linux	macOS
Open search	`Ctrl + K`	`⌘ + K`
Close search	`Escape`	`Escape`

How to Use

Log in to the Magento back-office
Use the configured keyboard shortcut to open the search box
Type part of the configuration path (e.g., catalog/product, web/secure, etc.)
Select a result with the arrow keys or click on it
Press Enter or click to navigate to the configuration section

Search Examples

catalog/product - Product settings
web/secure - HTTPS settings
payment - Payment settings
shipping - Shipping settings
customer/account - Customer account settings

Module Structure

Xguenel/ConfigSearch/
├── Block/
│   └── Adminhtml/
│       └── System/
│           └── Config/
│               └── SearchBox.php           # Block for the search box
├── Model/
│   └── Config/
│       └── Source/
│           └── ModifierType.php            # Source model for modifier type
├── etc/
│   ├── acl.xml                             # ACL permissions definition
│   ├── adminhtml/
│   │   └── system.xml                      # Admin system configuration
│   ├── config.xml                          # Default configuration values
│   └── module.xml                          # Module declaration
├── i18n/
│   ├── en_US.csv                           # English translations
│   └── fr_FR.csv                           # French translations
├── view/
│   └── adminhtml/
│       ├── layout/
│       │   └── default.xml                 # Layout to include the template
│       ├── templates/
│       │   └── system/
│       │       └── config/
│       │           └── searchbox.phtml     # Template with JavaScript
│       └── web/
│           └── css/
│               └── config-search.css       # CSS styles
├── composer.json                           # Composer dependencies
├── LICENSE                                 # License file
├── registration.php                        # Module registration
├── README.md                               # This file (English)
└── README_FR.md                            # French documentation

ACL Permissions

The module defines an ACL permission for configuration access:

Xguenel_ConfigSearch::config - Access to module configuration

Browser Compatibility

The module is compatible with all modern browsers supporting:

ES5 JavaScript
jQuery (included in Magento)
The KeyboardEvent API
The User-Agent Client Hints API (with fallback to navigator.userAgent for older browsers)

Technical Notes

Platform Detection

The module uses the modern User-Agent Client Hints API to detect macOS, with a fallback to navigator.userAgent for older browsers. This allows using the Command key (⌘) instead of Ctrl on Apple systems.

Configuration Paths

Configuration paths are dynamically extracted from the Magento configuration structure. The module traverses all sections, groups, and fields defined in the system.xml files of all installed modules.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Xguenel

Support

For any questions or issues, please create an issue in the project repository.

Changelog

Version 1.0.0

Initial release
Configuration path search with autocomplete
Configurable keyboard shortcut
Modifier choice (Ctrl or Shift + Ctrl)
macOS support with Command key
Module enable/disable option

xguenel / module-config-search

Maintainers

Details