https://github.com/live627/remu

A menu system for converting a standard menu into a mobile/tablet responsive menu, media query independent.
https://github.com/live627/remu

navigation

Last synced: 1 day ago
JSON representation

A menu system for converting a standard menu into a mobile/tablet responsive menu, media query independent.

• Host: GitHub
• URL: https://github.com/live627/remu
• Owner: live627
• License: mit
• Created: 2016-07-30T00:31:30.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-10T00:08:07.000Z (almost 2 years ago)
• Last Synced: 2024-08-31T18:06:06.442Z (about 1 month ago)
• Topics: navigation
• Language: JavaScript
• Homepage: http://live627.github.io/remu/demo.html
• Size: 165 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Remu v1.0

A menu system for converting a standard menu into a mobile/tablet responsive menu, media query independent.

**Please note: This is not a menu system replacement. It is simply a lightweight script to convert a standard navigation into a mobile/tablet navigation.**

[Live Demo](http://live627.github.io/remu/demo.html)

## Features

- Lightweight

- CSS3 animations

- Webkit/Browserify support

- Single-page-application support

## Installation

Install from npm:

```sh

npm install remu

```

## Usage

CommonJS:

```js

var Remu = require('remu');

```

Remu is also expposed globally.

    

    

    

        var Remu = new Remu({

            singlePage: true

        });

        document.getElementById('show').addEventListener('click', Remu.show);

        document.getElementById('hide').addEventListener('click', Remu.hide);

    

### Options

- `remuContainer: 'body'` Choose where Remu will be placed within the HTML

- `remuScreenWidth: "480"` Set the screen width you want Remu to kick in at

- `remuRemoveAttrs: false` true to remove classes and IDs, false to keep them

- `singlePage: false` set to true for single page sites, the navigation will close back up on itself on click

- `remuDisplay: "block"` by default this is block, sometimes you may want to switch this to table or table-cell or inline-block etc. so now you can.

### Methods

- `show` Shows Remu. Screen width is not taken into consideration, so it will work regardless of the viewport.

- `hide` Will hide Remu and restore the original menu.