Giter VIP home page Giter VIP logo

rs-slide-menu's Introduction

RS Slide Menu

Simple slide menu, without deps

Example

See example dir

Installation

npm install rs-slide-menu

Usage

Markup

<div id="nav">
    <div class="m-menu_item">
        <a href="#">Shop</a>
    </div>

    <div class="m-menu_item">
        <a href="#">About</a>
    </div>

    <div class="m-menu_item">
        <a href="#">Contacts</a>
    </div>
</div>

<button class="js-open-nav">Open</button>

<script src="rs-slide-menu.min.js"></script>
<script>
  var menu = SlideMenu.init('#nav', {
      toggler: '.js-open-nav'
  });
</script>

Styles

#nav {
    display: none;
}

Options

Default options

{
  "prefix": "rs-sm",
  "side": "left",
  "zIndex": "1500",
  "bgColor": "#000",
  "bgOpacity": "0.6",
  "animation": {
    "duration": "300",
    "easing": "ease"
  }
}
Option Type Description
toggler string css selector of togglers
prefix string prefix to all class names
side string ('left', 'right') which side show menu
zIndex number z-index of menu
bgColor string color of backdrop
bgOpacity string opacity of backdrop
animation object animation params
duration string/number transition duration in ms
easing string transition timing function

Lint and build (for developers)

npm run lint
npm run build

License

Released under the MIT License. See the bundled LICENSE file for details.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.