# mageworx/module-searchsuiteautocomplete

> Search Suite Autocomplete extension by MageWorx for Magento 2

`composer require mageworx/module-searchsuiteautocomplete`

Canonical URL: https://packagento.com/mageworx/module-searchsuiteautocomplete

## At a glance

- **Vendor**: mageworx (https://packagento.com/mageworx.md)
- **Latest version**: 2.2.0 — released 2023-05-17
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mageworx/module-searchsuiteautocomplete and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mageworx/module-searchsuiteautocomplete:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Search Suite Autocomplete extension by MageWorx for Magento 2

## README

<img align="right" style="float: right; height: 200px;" src="doc/images/search_autocomplete_logo.png">

## Search Autocomplete for Magento 2

Autocomplete search suggestions are common nowadays. When designed well, this functionality helps shoppers to construct their search queries and get to the searched products faster. Search Autocomplete was designed to make searching simple and intuitive. It delivers quick and precise results, thus helping customers get more effective queries.
Autocomplete functionality provides the intuitive search experience and instantly displays search suggestions based on the first-entered characters. This functionality helps customers move from the search box to the checkout as quickly as possible.

![](doc/images/search_autocomplete_popup.png)

### Features

**Instant search results in a customizable AJAX pop-up**  
**Suggested searches**   
**Smart search queries caching**  
**Adjustable search delay period**  
**The ability to specify the # of displayed search results**  
**Including product details (product image, SKU, price, reviews/ratings, etc.)**  
**"Add to Cart" button right in the search results**  

### How to install Search Suite Autocomplete for Magento 2

#### Install via composer (recommend)
Run the following command in Magento 2 root folder:

```
composer require mageworx/module-searchsuiteautocomplete
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
```

#### Install ready-to-paste package (not recommend)

- Download the latest version [here](https://www.mageworx.com/magento-2-search-atocomplete-free.html)
-  [Installation guide](https://support.mageworx.com/manuals/autocomplete/#installation-by-copying-the-code)

### Changelog

[Changelog](changelog.md)

### Authors, contributors and maintainers

Author:
- [MageWorx](https://www.mageworx.com)

### Ideas, bugs, contributions, comments, feature suggestions?

Please get in touch with us via the [issue tracker on GitHub](https://github.com/mageworx/search-suite-autocomplete/issues)

### Compability

- PHP: 
  - 5.6.x
  - 7.0.x
  - 7.1.x
  - 7.2.x
- Magento CE: 
  - 2.0.x
  - 2.1.x
  - 2.2.x
  - 2.3.x
  - 2.4.x
- Magento EE:
  - 2.0.x
  - 2.1.x
  - 2.2.x
  - 2.3.x
  - 2.4.x
  
- Operating System: Linux

### Documentation

1. [Module Configuration](https://support.mageworx.com/manuals/autocomplete/#extension-configuration)

### License

[GPL v3](LICENSE.txt)

### Links

- [Search Suite Autocomplete on Magento Connect](https://marketplace.magento.com/mageworx-module-searchsuiteautocompletemeta.html)
- [Search Suite Autocomplete on MageWorx site](https://www.mageworx.com/magento-2-search-atocomplete-free.html)

## Changelog

#### Version 2.1.4

- **Fix**: Update locale file

#### Version 2.1.9

- **Fix**: Hide "Add to Cart" button in search popup for unavailable products

#### Version 2.1.10

- **Fix**: Add sort order by relevance

#### Version 2.1.11

- **Fix**: Add review summary to collection
- **Fix**: Use product small image from cache for the search popup

#### Version 2.1.12
- Add composer compatibility for magento 2.4
- Remove promotion from the config setting section

#### Version 2.1.13
- **Fix** Crop HTML from product description in search popup

#### Version 2.1.14
- Add compatibility with Magento 2.4.4 and Elasticsearch

## Recent Versions

| Version | Released |
|---|---|
| 2.2.0 | 2023-05-17 |
| 2.1.14 | 2022-08-04 |
| 2.1.13 | 2020-08-19 |
| 2.1.12 | 2020-08-17 |
| 2.1.11 | 2020-05-29 |
| 2.1.10 | 2020-03-27 |
| 2.1.9 | 2019-12-18 |
| 2.1.8 | 2019-08-22 |
| 2.1.6 | 2019-02-05 |
| 2.1.5 | 2018-12-11 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=100.0.0 <104 |
| magento/module-catalog | >=100.0.0 <105 |
| magento/module-search | >=100.0.0 <102 |

## Quality

Latest release (2.2.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 31 | 31 warnings (ruleset: Magento2) — 8 auto-fixable with phpcbf |
| PHPMD | Warning | 15 | 15 rule violations (UndefinedVariable:13, UnusedFormalParameter:2) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 9 | 9 | – | – |
| 2.4.8 | – | 9 | 9 | – |
| 2.4.9 | – | – | 8 | 8 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mageworx/module-searchsuiteautocomplete"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mageworx is a Magento 2 vendor on Packagento. See https://packagento.com/mageworx.md for their full catalogue.