<commit_before># Pussshy

Pussshy is a forked version of [<NAME>'s Pushy](https://github.com/christophery/pushy/), a responsive off-canvas navigation menu using CSS transforms & transitions.

It has been re-written to include several new modern features thats going to make you web application more robust.


## Features
New and modern features included in this version:

* Bi-directional.
* Supports multiple menus and multiple canvasses.
* Custom class targets.
* CommonJS-ready for your [browserify](http://browserify.org/)-ing needs  <br/> (exported to both `window` and `module` exports).
* Included source SASS (.scss) files for you to easily customise it to your project needs.

Plus all the goodness from [the original version](https://github.com/christophery/pushy/):

* Uses CSS transforms & transitions.
* Smooth performance on mobile devices.
* jQuery animation fallback for IE 7 - 9.
* Responsive.


## Requirements
* jQuery v1.11.x and above

For list of supported browsers, see [Browser support](#browser-support).


## Quickstart
1. Download Pussshy using one of the two methods
	* using [Bower](http://bower.io): <br/>```bower install pussshy```
	* directly from [packaged source](https://github.com/sogko/pussshy/archive/master.zip).
	
2. Include jQuery and Pussshy assets in your HTML.
<br/>Note: jQuery script has to come before `pussshy.min.js`
    ```html
    <link rel="stylesheet" href="{path-to-src}/pussshy.min.css"/>
    
    <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
    <script src="{path-to-src}/pussshy.min.js"></script>
    
    ```
3. Add the following markup in your HTML to define [the four 
(4) Pussshy components](#components)

    ```html
<!-- Pussshy off-canvas menu and its menu-items -->
<div class="pussshy__menu">
	<ul class="pussshy__menu-items">
		<li><a href="#">Menu item 1</a></li>
		<li><a href="#">Menu item 2</a></li>
		<li><a href="#">Add more items</a></li>
	</ul>
</div>

<!-- Pussshy content canvas --->
<div class="pussshy__canvas">
	<!-- insert content here -->
	<h1>Pussshy Demo</h1>
	
	<!-- include the Pussshy menu-button somewhere -->
	<button class="pussshy__menu-button">Show menu</button>
	
	<!-- more content here -->
	<p>Ipsum lorem and all that</p>
	<p>Ipsum lorem and all that</p>
	<p>Ipsum lorem and all that</p>
	<p>Ipsum lorem and all that</p>
</div>
    ```

4. Create a Pussshy instance
    ```html
<script>
	$(document).ready(function () {
		var opts = {}; // use default options
		var p = new Pussshy(opts);
	});
</script>
    ```

5. Done!

## API
### Components
Pussshy requires the following HTML components to work:

#### Content canvas
Class name: ```pussshy__canvas```

The content canvas contains content that will be moved off-canvas when the menu is active.

You can have multiple canvasses for each Pussshy instances. 

#### Off-canvas menu
Class name: ```pussshy__menu```

This is the menu that will start off from outside of the content canvas.

#### Menu items
Class name: ```pussshy__menu-items```

Menu items should be defined within ```pussshy__menu```.

#### Menu button<commit_msg>Fix typos<commit_after># Pussshy

Pussshy is a forked version of [<NAME>'s Pushy](https://github.com/christophery/pushy/), a responsive off-canvas navigation menu using CSS transforms & transitions.

It has been re-written to include several new modern features thats going to make your web application more robust.


## Features
New and modern features included in this version:

* Bi-directional.
* Supports multiple menus and multiple canvasses.
* Custom class targets.
* CommonJS-ready for your [browserify](http://browserify.org/)-ing needs  <br/> (exported to both `window` and `module` exports).
* Included source SASS (.scss) files for you to easily customise it to your project needs.

Plus all the goodness from [the original version](https://github.com/christophery/pushy/):

* Uses CSS transforms & transitions.
* Smooth performance on mobile devices.
* jQuery animation fallback for IE 7 - 9.
* Responsive.


## Requirements
* jQuery v1.11.x and above

For list of supported browsers, see [Browser support](#browser-support).


## Quickstart
1. Download Pussshy using one of the two methods
	* using [Bower](http://bower.io): <br/>```bower install pussshy```
	* directly from [packaged source](https://github.com/sogko/pussshy/archive/master.zip).
	
2. Include jQuery and Pussshy assets in your HTML.
<br/>Note: jQuery script has to come before `pussshy.min.js`
    ```html
    <link rel="stylesheet" href="{path-to-src}/pussshy.min.css"/>
    
    <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
    <script src="{path-to-src}/pussshy.min.js"></script>
    
    ```
3. Add the following markup in your HTML to define [the four 
(4) Pussshy components](#components)

    ```html
<!-- Pussshy off-canvas menu and its menu-items -->
<div class="pussshy__menu">
	<ul class="pussshy__menu-items">
		<li><a href="#">Menu item 1</a></li>
		<li><a href="#">Menu item 2</a></li>
		<li><a href="#">Add more items</a></li>
	</ul>
</div>

<!-- Pussshy content canvas -->
<div class="pussshy__canvas">
	<!-- insert content here -->
	<h1>Pussshy Demo</h1>
	
	<!-- include the Pussshy menu-button somewhere -->
	<button class="pussshy__menu-button">Show menu</button>
	
	<!-- more content here -->
	<p>Ipsum lorem and all that</p>
	<p>Ipsum lorem and all that</p>
	<p>Ipsum lorem and all that</p>
	<p>Ipsum lorem and all that</p>
</div>
    ```

4. Create a Pussshy instance
    ```html
<script>
	$(document).ready(function () {
		var opts = {}; // use default options
		var p = new Pussshy(opts);
	});
</script>
    ```

5. Done!

## API
### Components
Pussshy requires the following HTML components to work:

#### Content canvas

Class name: ```pussshy__canvas```

The content canvas contains content that will be moved off-canvas when the menu is active.

You can have multiple canvasses for each Pussshy instances. 

#### Off-canvas menu
Class name: ```pussshy__menu```

This is the menu that will start off from outside of the content canvas.

#### Menu items
Class name: ```pussshy__menu-items```

Menu items should be defined within ```pussshy__menu```.

#### Menu button
{'fraction_non_alphanumeric': 0.14304186196864394, 'fraction_numerical': 0.0061419104574107, 'mean_word_length': 3.9424920127795526, 'pattern_counts': {'":': 0, '<': 95, '<?xml version=': 0, '>': 95, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6214273', 'n_tokens_mistral': 2089, 'n_tokens_neox': 2000, 'n_words': 682}