totem.module.menu/README.md

Twig partial for outputting different variants of menu's.

# Totem module: menu
Twig partial for outputting different variants of menu's.

This module is created for [Totem](https://www.github.com/toolbarthomas/totem) projects, but can also be used in any other Twig related project.

## Installation
Install totem.module.menu with [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).


```bash
$ npm install totem.module.menu --save
```

## Usage
You can choose between a list of menu variants:
* Centered
* Right to left
* Justify
* Vertical
* Distribute

Use of a variant is possible by adding the corresponding class as a modifer on the base class.

## Snippets

### menu centered
```twig
    
<nav class="menu menu--center">
    <ul>
        <li><a href="">Lorem ipsum</a></li>
        <li><a href="">Dolor sit amet</a></li>
        <li><a href="">Sed do eiusmod.</a></li>
        <li>
            <a href="">dropdown</a>
            <div class="menu-dropdown">
                <div class="menu-dropdown-wrapper">
                    <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
                    tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
                    quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
                    consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
                    cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
                    proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
                </div>
            </div>
        </li>
    </ul>
</nav>
```

### menu right to left
```twig
    
<nav class="menu menu--right">
    <ul>
        <li><a href="">Lorem ipsum</a></li>
        <li><a href="">Dolor sit amet</a></li>
        <li><a href="">Sed do eiusmod.</a></li>
        <li>
            <a href="">dropdown</a>
            <div class="menu-dropdown">
                <div class="menu-dropdown-wrapper">
                    <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
                    tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
                    quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
                    consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
                    cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
                    proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
                </div>
            </div>
        </li>
    </ul>
</nav>
```

### menu justified
```twig
    
<nav class="menu menu--justify">
  <ul>
      <li><a href="">Lorem ipsum</a></li>
      <li><a href="">Dolor sit amet</a></li>
      <li><a href="">Sed do eiusmod.</a></li>
  </ul>
</nav>
```

### menu vertical
```twig
    
<nav class="menu menu--vertical">
    <ul>
        <li><a href="">Lorem ipsum</a></li>
        <li><a href="">Dolor sit amet</a></li>
        <li><a href="">Sed do eiusmod.</a></li>
    </ul>
</nav>
```

### menu distribute
```twig
    
<nav class="menu menu--distribute">
    <ul>
        <li><a href="">Lorem ipsum Dolor sit amet</a></li>
        <li><a href="">Dolor sit amet</a></li>
        <li><a href="">Sed do eiusmod.</a></li>
    </ul>
</nav>
```