Skip to content

arcs-/SwipeNav

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 

Repository files navigation

SwipeNav

Example Picture

Introduction

SwipeNav gives you the ability to transform your right navigationbar in a more mobile friendly version. (Picture above) This script is very simple to use and small. However while it's small, it also can't do anything you might like.

Help

Please don't hesitate to contact me with any questions! help@stillhart.biz

##Usage

###Including files You need JQuerry and the script it self

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script type=text/javascript src=js/swipeNav.min.js></script>

###Required HTML structure You neeed a navigation, something like this

<div id="navBar">
    <img src="drawer.svg" id="drawer"/>
    <div id="nav">

        <a class="active">Profile</a>
        <a href="devices.html">Devices</a>
        <a href="link.html">Link</a>

    </div>
</div>
#navBar {
    width: 320px;
    height: 100%;
    background: #333;
    position: fixed;
}

#drawerIcon {
    display:none;
}


@media only screen
and (max-width : 700px) {
    #navBar {
        width: 295px;
    }

    #drawerIcon {
        display: inline;
        position: absolute;
        width: 45px;
        margin-left: 295px;
    }
}

###Initialization This lines are in the file

...
  var navigation = '#navBar';     // Id from nav container
  var drawerIcon = '#drawerIcon'; // Id from drawericon
  var width = 295;                // Width of nav container
  var threshold = 170;            // At which point should auto open
  
  // Do this to "hide" the navigationbar
  $(navigation).css("marginLeft",'-'+width+'px');
...

##License The MIT License (MIT)

Copyright (c) 2014 Patrick Stillhart

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Small mobile navigation script

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published