Skip to content

heberalmeida/vue-menu-overlay

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vue-menu-overlay

A simple, menu overlay for VueJS (2.x)

Basic Screenshot

New support icon

Demo Icon Material Design

Live Demo

Demo Site

Getting Started

Prerequisites

The plugin is meant to be used with existing Vue 2.x projects. It uses ES6 features so as long as your build process includes a transpiler, you're good to go.

Github

GitHub

Installing

Install with npm:

npm install --save vue-menu-overlay

import into project:

import Vue from 'vue'
import VueMenuOverlay from 'vue-menu-overlay'

Vue.use(VueMenuOverlay)

Example Usage

<template>
  <div>
    <vue-menu-overlay :menus="links" label="Menu"></vue-menu-overlay>
  </div>
</template>

<script>
  import Vue from 'vue'
  import VueMenuOverlay from 'vue-menu-overlay'
  Vue.use(VueMenuOverlay)
  export default {
    data(){
      return {
          links: [
              { title: 'Google Search', url: 'http://www.google.com', target: '_black'},
              { title: 'Yahoo Search', url: 'http://www.yahoo.com', target: '_black'},
              { title: 'Facebook', url: 'http://www.facebook.com', target: '_black'},
              { title: 'Flickr', url: 'http://www.flickr.com', target: '_black'}
          ]
      }
    }
  }
</script>

Component Options

Option Description Type, Example
label text label menu String, "Menu"
If not set, the label "Open Menu".
icon icon label menu String, "fa fa-bars"
icon fontawesome example
material icon material design String, "icon material"
icon material design
label text label menu String, "Menu"
If not set, the label "Open Menu".
menus Array containing objects
  [
    {
      title: String,
      url: String,
      target: String (optional), 
      icon: String (optional) *import libs icon <-set class icon,
      material: String (optional) if icon material design
    }
    //...
  ]

Authors

License

This project is licensed under the MIT License

Acknowledgments

Inspiration, layout taken from

About

A simple, menu overlay for VueJS (2.x)

Resources

Stars

Watchers

Forks

Packages

No packages published