GithubHelp home page GithubHelp logo

e1jo / zeynepjs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from hsynlms/zeynepjs

0.0 1.0 0.0 184 KB

a lightweight multi-level jQuery side menu plugin

Home Page: https://codepen.io/hsynlms/pen/xMbGaO

License: MIT License

JavaScript 88.75% CSS 11.25%

zeynepjs's Introduction

zeynepjs

A lightweight multi-level jQuery side menu plugin.

NPM

zeynepjs can be initialized for any existing HTML element and supports multi-level nested submenus. It's customizable by CSS and options.

Note: There are a lot of breaking changes so v2.x is not compatible with v1.x.

Options

Option Type Default Description
htmlClass boolean true If true zeynepjs will add some classes to <html> element like zeynep-initialized, zeynep-opened

Events

Name Description
loading Fired when the menu is being loaded
load Fired when the menu is loaded
opening Fired when the menu is being opened
opened Fired when the menu is opened
closing Fired when the menu is being closed
closed Fired when the menu is closed
destroying Fired when the menu is being destroyed
destroyed Fired when the menu is destroyed

Events can also be defined in options.

Usage

// initialize zeynepjs and get the instance into a variable
var zeynep = $('.zeynep').zeynep({
  load: function (element, options) {
    console.log('zeynepjs menu is successfully loaded')
  }
})

// opens the menu
zeynep.open()

// closes the menu
zeynep.close()

// dynamically event binding
zeynep.on('closing', function () {
  console.log('guys, the side menu is closing')
})

// destroys the menu
zeynep.destroy()

Contribution

Contributions and pull requests are kindly welcomed!

License

This project is licensed under the terms of the MIT license.

zeynepjs's People

Contributors

hsynlms avatar

Watchers

James Cloos avatar

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.