Download the PHP package xguenel/module-config-search without Composer
On this page you can find all versions of the php package xguenel/module-config-search. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download xguenel/module-config-search
More information about xguenel/module-config-search
Files in xguenel/module-config-search
Package module-config-search
Short Description Magento 2 module that allows you to quickly search for configuration paths in the Magento back-office using a keyboard shortcut.
License MIT
Informations about the package module-config-search
Xguenel_ConfigSearch
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:
-
Copy the module files to this directory
-
Enable the module:
- Update the database and recompile:
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 settingsweb/secure- HTTPS settingspayment- Payment settingsshipping- Shipping settingscustomer/account- Customer account settings
Module Structure
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
KeyboardEventAPI - The
User-Agent Client HintsAPI (with fallback tonavigator.userAgentfor 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
© 2025 Xguenel. All rights reserved.
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