<commit_before>Mobile-Mega-Menu
================

The mobile mega menu is designed to allow for deep menu structures to be navigated easily on mobile devices. It has a left-right animation that makes it easy to understand where you are in the menu hierarchy.

##Installation
Install Bower Components with [Bower](http://bower.io/): ``` bower install ```

Install NPM Components with [NPM](https://www.npmjs.org/): ``` npm install ```

Run Development Server for Sass editing with [Grunt](http://gruntjs.com/): ``` grunt serve ```

Build files with [Grunt](http://gruntjs.com/): ``` grunt build ```

##Usage
Add Mobile Mega Menu CSS
```html
<link rel="stylesheet" href="css/jquery.mobile-mega-menu.min.css">
```

Load Modernizr
```html
<script src="bower_components/modernizr/modernizr.js" type="text/javascript"></script>
```

Load Jquery
```html
<script src="bower_components/jquery/dist/jquery.min.js" ></script>
```

Load Mobile Mega Menu JS
```html
<script src="js/jquery.mobile-mega-menu.min.js" ></script>
```

Initiate Plugin
```javascript
$( '.mobile-mega-menu' ).mobileMegaMenu({
	changeToggleText: false,
	enableWidgetRegion: false,
	prependCloseButton: false,
	stayOnActive: true,
	toogleTextOnClose: 'Close Menu',
	targetClass: 'mobile-mega-menu',
	menuToggle: 'toggle-menu'
});
```

## Options
**changeToggleText** - default - true
- Use this with toogleTextOnClose to change the text of the button that will open your menu.

**toogleTextOnClose** - default - Close Menu
- If changeToggleText is true then you can change the toggle text with this option. The initial text that is used on your menu toggle will be the default for when the menu is closed.

**enableWidgetRegion** - default - false
- Specify a div element with class of widget-region then place other items within that region to then have it appear below the first unordered list item. This can be search fields, social media links, or any valid HTML.

**prependCloseButton** - default - false
- If the menu will be covering the entire screen you can add a close button at the top of the menu stack.

**stayOnActive** - default - true
- When set to true, the menu level where you select a page will be present the first time you open the menu after the page loads again.

**targetClass** - default - mobile-mega-menu
- Target the menu to be used with the plugin.

**menuToggle** - default - toggle-menu
- Create a class for the button that will toggle the specific menu.

##Contact
   * Twitter: [https://twitter.com/BlakeCerecero][1]
   * Portfolio: [http://digitalblake.com/][2]
   
[1]: https://twitter.com/BlakeCerecero "https://twitter.com/BlakeCerecero"
[2]: http://digitalblake.com/ "http://digitalblake.com/"

This content is released under the [MIT License](http://opensource.org/licenses/MIT).<commit_msg>[md] ReadMe file updates<commit_after>Mobile Mega Menu
================

The mobile mega menu is designed to allow for deep menu structures to be navigated easily on mobile devices. It has a left-right animation that makes it easy to understand where you are in the menu hierarchy.

##Installation
Install with [Bower](http://bower.io/): ```bower install mobile-mega-menu --save```

##Usage
Add Mobile Mega Menu CSS
```html
<link rel="stylesheet" href="css/jquery.mobile-mega-menu.min.css">
```

Load Modernizr
```html
<script src="bower_components/modernizr/modernizr.js" type="text/javascript"></script>
```

Load Jquery
```html
<script src="bower_components/jquery/dist/jquery.min.js" ></script>
```

Load Mobile Mega Menu JS
```html
<script src="js/jquery.mobile-mega-menu.min.js" ></script>
```

Initiate Plugin
```javascript
$( '.mobile-mega-menu' ).mobileMegaMenu({
	changeToggleText: false,
	enableWidgetRegion: false,
	prependCloseButton: false,
	stayOnActive: true,
	toogleTextOnClose: 'Close Menu',
	targetClass: 'mobile-mega-menu',
	menuToggle: 'toggle-menu'
});
```

## Options
**changeToggleText** - default - true
- Use this with toogleTextOnClose to change the text of the button that will open your menu.

**toogleTextOnClose** - default - Close Menu
- If changeToggleText is true then you can change the toggle text with this option. The initial text that is used on your menu toggle will be the default for when the menu is closed.

**enableWidgetRegion** - default - false
- Specify a div element with class of widget-region then place other items within that region to then have it appear below the first unordered list item. This can be search fields, social media links, or any valid HTML.

**prependCloseButton** - default - false
- If the menu will be covering the entire screen you can add a close button at the top of the menu stack.

**stayOnActive** - default - true
- When set to true, the menu level where you select a page will be present the first time you open the menu after the page loads again.

**targetClass** - default - mobile-mega-menu
- Target the menu to be used with the plugin.

**menuToggle** - default - toggle-menu
- Create a class for the button that will toggle the specific menu.

##Contact
   * Twitter: [https://twitter.com/BlakeCerecero][1]
   * Portfolio: [http://digitalblake.com/][2]
   
[1]: https://twitter.com/BlakeCerecero "https://twitter.com/BlakeCerecero"
[2]: http://digitalblake.com/ "http://digitalblake.com/"

This content is released under the [MIT License](http://opensource.org/licenses/MIT).
{'fraction_non_alphanumeric': 0.12117251680358476, 'fraction_numerical': 0.0014936519790888724, 'mean_word_length': 4.438578680203046, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 17, 'https://': 7, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2572923', 'n_tokens_mistral': 1601, 'n_tokens_neox': 1550, 'n_words': 621}