# metisMenu-stateful

**Repository Path**: xskonline/metisMenu-stateful

## Basic Information

- **Project Name**: metisMenu-stateful
- **Description**: Bootstrap菜单插件metisMenu的增强版，支持展开状态记忆和当前菜单高亮。
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 13
- **Forks**: 1
- **Created**: 2014-09-21
- **Last Updated**: 2023-01-29

## Categories & Tags

**Categories**: bootstrap-plugins

**Tags**: None

## README

# metisMenu-stateful
----------

## 说明

metisMenu-stateful 是“有状态”的 metisMenu 。其综合了 [onokumus/metisMenu](https://github.com/onokumus/metisMenu) v1.0.3 和 [valgen/metisMenu](https://github.com/valgen/metisMenu) 的特性，并修正了各自的一些 BUG 。此外，还增加了对当前所展开菜单的高亮显示支持。后续将根据原 repo 跟进新特性更新。

## Usage

0. Add a Style Class(Default:.nav-current) in Your CSS if You Want to Highlight the Current Menu
    
    ```css
    .nav-current {
        font-weight: bold;
        color: #5cb85c;
    } /* Custom by yourself */
    ```

1. Include Twitter Bootstrap StyleSheet

2. Include metisMenu StyleSheet

    ```html
    <link rel="stylesheet" href="metismenu.css">
    ```

3. Include jQuery

    ```html
    <script src="jquery.min.js"></script>
    ```

4. Include Twitter Bootstrap Script

    ```html
    <script src="bootstrap.min.js"></script>
    ```

5. Include metisMenu plugin's code

    ```html
    <script src="metismenu.js"></script>
    ```

6. Call the plugin:

    ```javascript
    $("#menu").metisMenu();
    ```

## License

MIT License