/Responsive-Menu

WordPress Responsive Menu Plugin

Primary LanguagePHP

=== Responsive Menu ===
Contributors: peter.featherstone
Donate link: http://www.peterfeatherstone.com/donate/
Tags: responsive, menu, responsive menu, mobile menu, tablet menu, mobile, tablet, 3 lines, 3 line, three line, three lines
Requires at least: 3.5.0
Tested up to: 4.2.2
Stable tag: 2.6
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

This is a Highly Customisable Responsive Menu Created By Peter Featherstone

== Description ==

This is a Highly Customisable Responsive Menu Plugin, with 69 customisable options for a nice mobile menu or tablet menu experience enabling you to change the: 
<br />
<ul>
<li> - Menu Title</li>
<li> - Menu Title Image</li>
<li> - Button Title</li>
<li> - Button Title Image</li>
<li> - Menu To Responsify</li>
<li> - Media Query Breakpoint Width</li>
<li> - CSS Options For Hiding Specific Elements</li>
<li> - Menu Depth To Display</li>
<li> - Top Location</li>
<li> - Right Percentage Location</li>
<li> - Line & Text Colour</li>
<li> - Menu Button Background Colour</li>
<li> - Absolute and Fixed Positioning</li>
<li> - Menu Font</li>
<li> - Menu Title Colour</li>
<li> - Menu Title Hover Colour</li>
<li> - Menu Title Background Colour</li>
<li> - Menu Text Colour</li>
<li> - Menu Text Hover Colour</li>
<li> - Menu Background Colour</li>
<li> - Menu Link Background Hover Colour</li>
<li> - Menu Text Size</li>
<li> - Menu Button Text Size</li>
<li> - Menu Links Text Size</li>
<li> - Choose Overlay or Push Animations</li>
<li> - Slide Animation Speed</li>
<li> - Ability to auto expand/hide sub-menus</li>
<li> - Inclusion/Exclusion of Search Box</li>
<li> - Choice of Positioning of Search Box</li>
<li> - Transition speed</li>
<li> - Slide Animation Speed</li>
<li> - Menu Link Heights</li>
<li> - Text Alignment</li>
<li> - Choice of side to slide in from (left, right, top, bottom)</li>
<li> - Choice to use inline/external stylesheets and scripts</li>
<li> - Option to include JavaScript in footer</li>
<li> - Option to remove CSS !important tags</li>
<li> - Choice to Minify created CSS and JS files (saves up to 50% file space)</li>
<li> - Choice to auto-close menu items on click (for single page sites)</li>
<li> - Choice to replace 3 lines with an x on click</li>
<li> - Minimum width of menu</li>
<li> - Maximum width of menu</li>
<li> - Choice to Auto Expand Parent Links</li>
<li> - Choice to Ignore Clicks on Ancestor Links</li>
<li> - Choice to Close Menu Automatically on Page Clicks</li>
<li> - Choice to Specify Title Menu Link</li>
<li> - Choice to Specify Title Menu Link Location</li>
<li> - Ability to add custom HTML snippet inside the menu</li>
<li> - Choice of location for custom HTML snippet inside the menu</li>
<li> - Choice of using shortode or not</li>
<li> - Ability to change the 3 lines height</li>
<li> - Ability to change the 3 lines width</li>
<li> - Ability to Export Options</li>
<li> - Ability to Import Options</li>
<li> - Ability to set sub menu arrow shape/image Options</li>
<li> - Ability to set custom click trigger</li>
<li> - Ability to push menu button with animation</li>
<li> - Ability to change Current Page background hover colour</li>
<li> - Ability to change Current Page Link hover colour</li>
<li> - Ability to provide a custom walker option</li>
<li> - Ability to choose to use transient caching or not</li>
<li> - Ability to choose if menu is shown on left or right of screen</li>
<li> - Plus more...</li>
</ul>
The plugin creates a nice three-lined mobile menu button (or custom image if you choose) that users can click to bring a slide out menu (from the left, right, top or bottom - again your choice), which is easily navigated. A lot nicer and neater than the select drop-down menu alternative.
<br /><br />
The plugin is fully responsive if you have the viewport meta tag on your site, using media queries with the widths defined by you. It can be used as a responsive menu, mobile menu, tablet menu or full dedicated menu for your main site.
<br /><br />
It requires no shortcodes (although you can use them) or fancy php code to be inserted by yourself making it very easy to install, with 59 customisable options, you can get it to look exactly as you want it to or leave it with its default values to have it looking amazing in just a matter of seconds.
<br /><br />
You have the choice to include the stylesheets and scripts inline to avoid adding any extra HTTP requests to your site or through external stylesheets created by the plug-in. Either way, the code added is extremely small (only a little jQuery and CSS) and there is even an option to minify the output if you wish saving a further 50% on file space.
<br /><br />
It also includes the following functionality:
<ul>
<li> - WPML/Polylang Support</li>
<li> - Transient Caching to serious increase load speed</li>
<li> - Croatian translation - Massive thanks to <a href="https://www.facebook.com/pages/Neverone-design/490262371018076">Neverone Design</a> for this!</li>
<li> - Spanish Translation - Massive thanks to Andrew @ <a href="http://www.webhostinghub.com">WebHostingHub</a> for this!</li>
<li> - Dutch Translation - Massive thanks to Carlo @ <a href="http://www.quinex.nl/">Quinex</a> for this!</li>
</ul>
Please see the current development list on the below page:

<a href="http://peterfeatherstone.com/wordpress/responsive-menu/responsive-menu-development-list/">Development List</a>

If you would like to see any other options added to the plugin or would like to help with translating the plugin into various versions then please email me or place them in a support ticket.
<br />

== Installation ==

1. Upload `responsive-menu` to the `/wp-content/plugins/` directory
2. Activate the plugin through the `Plugins` menu in WordPress
3. Set your options from the Responsive Menu admin area

Alternatively:

1. Login to your WordPress admin area
2. Search for `Responsive Menu`
3. Click install `Responsive Menu`
4. Activate through the `Plugins` menu in WordPress or when asked during installation
5. Set your options from the Responsive Menu admin area

== Frequently Asked Questions ==

<a target="_blank" href="http://peterfeatherstone.com/wordpress/responsive-menu/faq/">http://peterfeatherstone.com/wordpress/responsive-menu/faq/</a>

== Screenshots ==

1. Fully customisable Admin Screen

2. Example Front End Menu Button

3. Example Front End Expanded Menu

4. Example Custom Front End Menu Button Image

5. Example Custom Front End Expanded Menu

== Changelog ==

= 2.5 (20th May 2015) =
* Fixed issue with duplicate sub menu arrows
* Added option to set if menu is shown on left or right
* Fixed issue with custom sub menu classes
* Button now compatible with Apple Voiceover
* Changed "X" close icon to the math symbol "x" - Thanks to patlog for the idea!
* Added many more shortcode options as below:           
                     
    - "title"
    - "title_link"
    - "title_open"
    - "title_img"
    - "html"
    - "html_loc"
    - "search_loc"
    - "btn_img"
    - "btn_img_clicked"
    - "btn_title"

= 2.4 (18th Feb 2015) =

* Added option to turn transient caching off as it causes issues with active link colours etc.
* Made Menu clear the transient caches and rebuild menu on Menu/Page/Post updates.

= 2.3 (16th Feb 2015) =

* Added ability to set custom click menu trigger
* Added ability to set custom walker function - Thanks to Mickael Desgranges for this 
* Added option to push menu button with animation
* Added option to change Current Page background hover colour
* Added option to change Current Page Link hover colour
* Fixed issue with accordion menu not retracting
* Enabled 0 values for animation speed to in affect remove animation
* Added easy view of Shortcode options in admin
* Added ability to place shortcodes in extra html content - Thanks to Mickael Desgranges for this 
* Leveraged WordPress persistent transient caching to significantly increase load speed

= 2.2 (29th Oct 2014) =

* Added Ability to Export Options
* Added Ability to Import Options
* Added option to change 3 lines width
* Added option to change 3 lines height
* Added option to change 3 lines margin
* Added option to change sub arrows using HTML shape or Image
* Added option to change the click menu image once clicked
* Sub Menu Animation added to improve smoothness
* Accordion sub menu animation option
* Added shortcode option to change menu (use "RM" argument) eg. [responsive-menu RM="footer-menu"]
* Minor bug fixes

= 2.1 (17th Aug 2014) =

* Basic shortcode support added - To use, tick the option in the admin and use the shortcode [responsive-menu]
* Multiple bug fixes

= 2.0 (13th Aug 2014) =

*** WE HAVE REACHED OVER 50 CUSTOMISABLE OPTIONS! ***

* Complete overhaul of the codebase
* Increased menu depth to 5
* Added Spanish Translation - Massive thanks to Andrew @ <a href="http://www.webhostinghub.com">WebHostingHub</a> for this!
* 'Double Click' menu bug fixed
* Various bug fixes
* Added Choice to Auto Expand Parent Links
* Added Choice to Ignore Clicks on Ancestor Links
* Added Choice to Close Menu Automatically on Page Clicks
* Added Top and Bottom Slide Options
* Added Option to set a Maximum Width for the menu
* Added Choice of Positioning of Search Box
* Added Choice to Specify Title Menu Link
* Added Choice to Specify Title Menu Link Location
* Added Ability to add custom HTML snippet inside the menu
* Added Choice of location for custom HTML snippet inside the menu
* Detect if WP Login bar is active and adjust accordingly

= 1.9 (5th Apr 2014) =

* Changed where custom CSS/JS files are stored. If you have issues when upgrading, please just click "Update Options" from admin and this should return back to normal.
* Added option to include scripts in footer
* Added ability to upload custom menu button image to replace the 3 lines
* Added ability to close menu on each link click (good for single page sites)
* Added ability to minify output (saving 50% on file size)
* Remove title section if title and image are empty
* Added ability to change 3 lines to an x when clicked
* Added ability to set the minimum width of the menu
* Added Croatian Translation - Massive thanks to <a href="https://www.facebook.com/pages/Neverone-design/490262371018076">Neverone Design</a> for this!

= 1.8 (26th Mar 2014) =

* Added option to include styles/scripts externally/internally
* Added WPML Support
* Added internationalisation functionality, awaiting translations
* Added ability to choose which side the menu slides in from
* Minor Code Improvements

= 1.7 (13th Mar 2014) =

* Ability to auto expand/hide sub-menus
* Inclusion/Exclusion of Search Box
* Transition speed
* Slide Animation Speed
* Menu Link Heights
* Text Alignment
* Removed potential jQuery conflicts
* Minor Code Improvements

= 1.6 (6th Mar 2014) =

* Added Animation Options Section
* Added Animation Speed Customisation Option
* Added Choice Of Slide Animation (Overlay or Push)
* Added Menu Title Background Colour Customisation Option
* Added Menu Title Font Size Customisation Option
* Added Click Menu Title Font Size Customisation Option
* Added Menu Links Font Size Customisation Option
* Removed Image Size Restriction
* Minor Code Improvements

= 1.5 (4th Mar 2014) =

* Added Menu Title Colour Customisation Option
* Added Menu Title Hover Colour Customisation Option
* Added Menu Text Colour Customisation Option
* Added Menu Text Hover Colour Customisation Option
* Added Menu Background Colour Customisation Option
* Added Menu Link Background Hover Colour Customisation Option
* Minor Code Improvements

= 1.4 (2nd Mar 2014) =

* Improved menu sliding animation.
* Fixed bug where the menu wouldn't retract on re-size.
* Removed the use of namespaces to support pre PHP 5.3 systems.

= 1.3 (1st Mar 2014) =

* Added ability to upload image for menu title.
* Added ability to switch between fixed and non-fixed positioning.
* Added ability to change menu font.
* Minor updates.

= 1.2 (28th Feb 2014) =

* Added support to include all site menus.

= 1.1 (25th Feb 2014) =

* Added transparent menu background option.

= 1.0 (22nd Feb 2014) =

* Initial Version Released.

== Upgrade Notice ==