https://github.com/dubbs/branchee

Branchee is a lightweight mobile navigation plugin with built in transitions.
https://github.com/dubbs/branchee

Last synced: 4 months ago
JSON representation

Branchee is a lightweight mobile navigation plugin with built in transitions.

• Host: GitHub
• URL: https://github.com/dubbs/branchee
• Owner: dubbs
• Created: 2014-11-11T23:29:04.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-09-05T21:06:59.000Z (almost 8 years ago)
• Last Synced: 2025-03-02T03:04:52.164Z (4 months ago)
• Language: CSS
• Homepage:
• Size: 43.9 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Branchee is a lightweight mobile navigation plugin with built in transitions.  The menu is generated from a basic unordered list.

## Menu

For the menu, wrap an unordered list with `.branchee-menu` and that with `branchee-theme-XXX`.

```html



  


    


      


Item 1

        


          


Item 1.1

            


              
Item 1.1.1

              
Item 1.1.2

              
Item 1.1.3

            

          

        

      

    

  



```


## Toggle

For the toggle, add a link to the page with `.branchee-toggle-menu` and whatever theme you are using.

```html

Toggle

```

## Plugin

Initialize the plugin by referencing the menu you created above

```js

$('#menu-1').branchee({

  onAfterInit: function () {

    this.toggleOpen();

  }

});

```

## Development

```bash

npm install

npm run watch-scss

```