=== HSArticle Foldout Menu ===
Contributors: hsarticle
Tags: menu, hamburger menu, slide menu, off-canvas menu, mobile menu
Requires at least: 6.0
Tested up to: 7.0
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Add a slide-out hamburger menu to any theme, via shortcode or automatic placement. Fully customizable position, colors, and slide direction.

== Description ==

HSArticle Foldout Menu adds a clean, accessible slide-out ("foldout") navigation panel to your site, triggered by a hamburger button.

**Two ways to place the trigger button:**

* Drop the `[hsarfold_menu]` shortcode anywhere — a widget, a page, a header template — and the trigger button appears there.
* Or turn on "Auto-Add Floating Button" and the plugin places a floating hamburger button in the top-left or top-right corner automatically, with adjustable padding.

**Fully customizable, all in one settings tab:**

* Choose which WordPress menu (Appearance → Menus) opens in the panel
* Pick the slide direction: left, right, top, or bottom
* Panel width/height percentage, background color or gradient, animation speed
* Menu text font, size, color, and hover color/size
* Icon style (3-line, dots, plus), icon color and hover color, size
* Optional dimming overlay behind the panel, with adjustable color/opacity
* Close button style (X icon, text, or none — click-outside/ESC always works)

**Built to not interfere with your site:**

* Every CSS class, ID, JS variable, and option name is uniquely prefixed
* Assets are only loaded on the frontend when the plugin is enabled
* Keyboard accessible: ESC to close, focus is trapped inside the open panel, focus returns to the trigger on close
* RTL-ready

== Installation ==

1. Upload the plugin files to `/wp-content/plugins/hsarticle-foldout-menu`, or install directly through the WordPress plugins screen.
2. Activate the plugin through the "Plugins" screen in WordPress.
3. Go to the "HSArticle Foldout Menu" tab in your wp-admin left sidebar.
4. Check "Enable HSArticle Foldout Menu", choose a menu to display, and configure the rest to taste.
5. Either place `[hsarfold_menu]` where you want the button, or enable "Auto-Add Floating Button".

== Frequently Asked Questions ==

= Does this work with any theme? =
Yes. It doesn't touch your theme's existing header or navigation — it adds an independent panel and trigger button on top of your site.

= Can I use my existing WordPress menu? =
Yes, choose any menu you've already created under Appearance → Menus.

= Will this conflict with my theme's mobile menu? =
No, HSArticle Foldout Menu is fully independent and uses uniquely prefixed CSS/JS, so it won't override or be overridden by other menu styles.

== Screenshots ==

1. Settings — General tab
2. Settings — Panel Style tab
3. Example of the slide-out panel open on the frontend

== Changelog ==

= 1.0.0 =
* Initial release.

== Upgrade Notice ==

= 1.0.0 =
Initial release.
