Skip to content

Lightweight, zero-configuration WooCommerce search

License

Notifications You must be signed in to change notification settings

tagpilot/top-shelf

Repository files navigation

=== Top Shelf Search ===
Contributors: mfrankiewicz, tagconcierge
Tags: woocommerce, search, overlay, products, fuzzy search
Requires at least: 5.6
Tested up to: 6.8
Requires PHP: 7.0
Stable tag: 1.0.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

A quick search overlay with fuzzy search functionality for WooCommerce products.

== Description ==

Top Shelf adds a zero-config, fast search overlay to your WooCommerce store, allowing customers to quickly find products using fuzzy search. The search overlay appears when customers click the search icon in your site's navigation menu.

Key Features:

* **Fuzzy Search**: Powered by Fuse.js for intelligent, typo-tolerant product search
* **Quick Access**: Search icon automatically added to your primary navigation menu
* **Fast Results**: RESTful API endpoint provides instant search results
* **Stock Status**: Shows real-time product availability
* **Clean Interface**: Elegant overlay design that doesn't interfere with your theme
* **Mobile Friendly**: Responsive design works on all device sizes

The plugin integrates seamlessly with WooCommerce and requires no configuration - simply activate and it's ready to use.

== Installation ==

1. Upload the `top-shelf` folder to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Ensure WooCommerce is installed and activated
4. The search icon will automatically appear in your primary navigation menu

== Frequently Asked Questions ==

= Does this work with any theme? =

Top Shelf works with any theme that uses WordPress's standard navigation menu system. The search icon is automatically added to your primary menu location.

= Is WooCommerce required? =

Yes, this plugin requires WooCommerce to be installed and activated as it searches WooCommerce products.

= Can I customize the search overlay appearance? =

The plugin includes clean, modern styling that should work well with most themes. Advanced users can override the CSS by adding custom styles to their theme.

= Can I disable the automatic menu integration? =

Currently, the search icon is automatically added to the primary menu. Future versions may include options to control this behavior.

== Changelog ==

= 1.0.1 =
* Initial public release
* Quick search overlay for WooCommerce products
* Fuzzy search functionality with Fuse.js
* Automatic menu integration
* Stock status display
* Mobile responsive design

== Screenshots ==

1. Search overlay in action showing product results
2. Search icon integrated into navigation menu

About

Lightweight, zero-configuration WooCommerce search

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •