KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #typescript #codex #cli #claude-code #mcp #rust #deepseek-harness #ai-agent

zeynepjs

★ 54 Open GitHub ↗

A lightweight multi-level jQuery side menu plugin

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# zeynepjs
> A lightweight multi-level jQuery side menu plugin.

[![Downloads](https://img.shields.io/npm/dm/zeynepjs.svg)](https://npmjs.com/zeynepjs)
[![install size](https://packagephobia.com/badge?p=zeynepjs)](https://packagephobia.com/result?p=zeynepjs)

`zeynepjs` is a light-weight multi-level jQuery side menu plugin. It's fully customizable and is compatible with modern browsers such as Google Chrome, Mozilla Firefox, Safari, Edge and Internet Explorer.

## Install
```
$ npm install zeynepjs --save
```

## Usage

```js
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()
```

## Using with Webpack
Once the library installed in your project, just import it:

```js
import 'zeynepjs'
```

## Options

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

## Methods

`zeynepjs` exposes those:

| Option            | Type     | Parameters                          | Description                                                                       |
| ---               | ---      | ---                                 | ---                                                                               |
| on                | function | `event name` and `handler function` | To dynamically event binding                                                      |
| open              | function | -                                   | To open the menu                                                                  |
| close             | function | `disableEvent` (optional)           | To close the menu. If `disableEvent` is passed true, no close event will be fired |
| destroy           | function | -                                   | To destroy the zeynepjs instance on initialized element                           |

## Events

> Events can also be defined in options.

### `loading(element, options)`

Fired when the menu is being loaded. This event cannot be defined dynamically. It needs to be defined in options.

`element` is the element that zeynepjs is being loaded on.