PHPackages                             xguenel/module-config-search - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Admin Panels](/categories/admin)
4. /
5. xguenel/module-config-search

ActiveMagento2-module[Admin Panels](/categories/admin)

xguenel/module-config-search
============================

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

1.0.0(5mo ago)0244↓50%MITHTML

Since Dec 17Pushed 5mo agoCompare

[ Source](https://github.com/xguenel/module-config-search)[ Packagist](https://packagist.org/packages/xguenel/module-config-search)[ RSS](/packages/xguenel-module-config-search/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (2)Versions (2)Used By (0)

Xguenel\_ConfigSearch
=====================

[](#xguenel_configsearch)

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

Description
-----------

[](#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
--------

[](#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
------------

[](#requirements)

- Magento 2.4.x
- PHP 8.1 or higher

Installation
------------

[](#installation)

### Manual Installation

[](#manual-installation)

1. Create the module directory:

    ```
    mkdir -p app/code/Xguenel/ConfigSearch
    ```
2. Copy the module files to this directory
3. Enable the module:

    ```
    bin/magento module:enable Xguenel_ConfigSearch
    ```
4. Update the database and recompile:

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

Configuration
-------------

[](#configuration)

Access the module configuration via:

**Stores &gt; Configuration &gt; Xguenel Extensions &gt; Config Search**

### Available Options

[](#available-options)

OptionDescriptionDefault ValueEnable ModuleEnables or disables the moduleYesShortcut KeyKey to open the search (with modifier)KModifier KeyKeyboard modifier (Ctrl or Shift + Ctrl)Ctrl### Modifier Options

[](#modifier-options)

OptionWindows/LinuxmacOSCtrl`Ctrl + [key]``⌘ + [key]`Shift + Ctrl`Shift + Ctrl + [key]``Shift + ⌘ + [key]`Usage
-----

[](#usage)

### Default Keyboard Shortcut

[](#default-keyboard-shortcut)

ActionWindows/LinuxmacOSOpen search`Ctrl + K``⌘ + K`Close search`Escape``Escape`### How to Use

[](#how-to-use)

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

### Search Examples

[](#search-examples)

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

Module Structure
----------------

[](#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
---------------

[](#acl-permissions)

The module defines an ACL permission for configuration access:

- `Xguenel_ConfigSearch::config` - Access to module configuration

Browser Compatibility
---------------------

[](#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
---------------

[](#technical-notes)

### Platform Detection

[](#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)

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
-------

[](#license)

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

Author
------

[](#author)

**Xguenel**

© 2025 Xguenel. All rights reserved.

Support
-------

[](#support)

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

Changelog
---------

[](#changelog)

### Version 1.0.0

[](#version-100)

- 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

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance73

Regular maintenance activity

Popularity15

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity34

Early-stage or recently created project

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

153d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b1087fc834becd7ceccc34b8a72ffe2cd1614c594ea1881890333bbb07cb3c59?d=identicon)[xguenel](/maintainers/xguenel)

---

Tags

phpmagentobackofficeshortcutmagento2collapsibleback office

### Embed Badge

![Health badge](/badges/xguenel-module-config-search/health.svg)

```
[![Health](https://phpackages.com/badges/xguenel-module-config-search/health.svg)](https://phpackages.com/packages/xguenel-module-config-search)
```

###  Alternatives

[redchamps/module-clean-admin-menu

It will merge all third party extensions menu items to single menu item named 'Extensions'.

164416.3k](/packages/redchamps-module-clean-admin-menu)[opengento/module-category-import-export

This module add the capability to import and export the categories from the back-office.

119.1k](/packages/opengento-module-category-import-export)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
