WordPress.org
Get WordPress

Plugin Directory

Changeset 2607578


Ignore:
Timestamp:
10/01/2021 04:27:52 AM (4 years ago)
Author:
jweathe
Message:

migrate modified readme to 1.1 release as a hotfix

File:
1 edited

Legend:

Unmodified
Added
Removed

  • mean-menu-refueled/tags/1.1/readme.txt

    r2607549 r2607578  
    1 === Mean menu Refueled ===
     1=== Mean Menu Refueled ===
    22Contributors: jweathe
    33Tags: mobile,responsive,menu,navigation
    … …  
    1414== Description ==
    1515Make your site navigation menu mobile-ready. When the threshold is reached, the targeted menu will collapse into a hamburger menu.
     16This plugin is a zero-dependency refresh on Mean Theme's MeanMenu plugin. This means that it does not require jQuery.
     17
     18== How To Use ==
     19The Mean Menu is configured with the WordPress Customizer in the menu section, and there are several options for customization.
     20
     21- **Menu target** A CSS selector to the closest container where the WordPress menu resides. The menu is usually an unordered list with a `menu` class.
     22- **Menu anchor** A CSS selector to the container where the mean menu will reside. If you're unsure, try `body`.
     23- **Bar colour** The bckground colour of the mean menu bar.
     24- **Menu colour** The background colour of the expanded mean menu.
     25- **Menu close** The symbol that will be used when the menu is expanded. This can be any unicode character or HTML entity.
     26- **Menu open** The symbol that will be used when the menu is collapsed. This can be any unicode character or HTML entity.
     27- **Reveal position** The justification of the mean menu state symbol.
     28- **Reveal position offset** Horizontal offset applied to the mean menu state symbol. This is intelligently applied depending on the justification, and has no effect when centered.
     29- **Reveal colour** The font colour of the mean menu state symbol.
     30- **Responsive threshold** The viewport threshold of when the mean menu replaced the standard menu.
     31- **Nav push** Vertical offset applied to the expanded component of the mean menu.
     32- **Show children** Check this to include nested levels in the mean menu.
     33- **Expandable children** Check this to allow nested levels to be expanded and collapsed. Otherwise, nested levels will be displayed by default.
     34- **Submenu open** Requires expandable children. The symbol that will be used when menu children are collapsed.
     35- **Submenu close** Requires expandable children.  The symbol that will be used when menu children are expanded.
     36- **Remove attributes** Remove classes and IDs from all elements of the default menu while the mean menu is active.
     37- **Hide elements** A CSS selector to any elements that should be hidden while the mean menu is active.
     38- **Single Page Site** Collapses the mean menu when a menu item is clicked.
     39- **Container display** The CSS display type of the mean menu container. inline, block, flex, etc
    1640
    1741== Installation ==
    1842Simply upload the zip using the Add New Plugin feature within WordPress admin as per usual.
     43
     44== Frequently Asked Questions ==
     45
     46= Can I target more than one menu =
     47
     48Mean Menu Refueled currently supports only one configuration and is intended to be applied to the primary menu.
     49
     50== Screenshots ==
     511. The collapsed menu on viewports smaller than the activation threshold.
     522. The expanded menu to the first level.
     533. The expanded menu with a second level expanded.
     544. Finding the Mean Menu in the menu section of the Customizer.
     555. Mean Menu options (1 of 4)
     566. Mean Menu options (2 of 4)
     577. Mean Menu options (3 of 4)
     588. Mean Menu options (4 of 4)
Note: See TracChangeset for help on using the changeset viewer.