vue-component-boilerplate

A Vue.js component to toggle navigation drawer menu container.

Install

Browser

<script src="vue.js"></script>
<script src="vue-nav-drawer.min.js"></script>

npm

npm install --save vue-nav-drawer

Usage

Browser

<div id="app">
  <nav-drawer-handle></nav-drawer-handle>
  <nav-drawer>
    MENU LIST
  </nav-drawer>
</div>

<script src="vue.js"></script>
<script src="vue-nav-drawer.min.js"></script>
<script>
Vue.use(NavDrawer);
new Vue({
  el: '#app'
});
</script>

SFC

<template>
  <nav-drawer-handle></nav-drawer-handle>
  <nav-drawer>
    MENU LIST
  </nav-drawer>
</template>

<script>
import { NavDrawer, NavDrawerHandle } from '@inotom/vue-nav-drawer';

export default {
  components: {
    NavDrawer,
    NavDrawerHandle
  }
}
</script>

Props

Props Type Default Description
size Number 50 Hamburger menu size(px)
weight String "normal" Hamburger menu line width (normal, thin, bold)
color String "#fff" Hamburger menu line color
bg-color String "#f6ac1d" Hamburger menu background color
fsize String "10px" Menu label text size
is-button Boolean false Add WAI-ARIA role button attribute
Props Type Default Description
is-left Boolean false Drawer container align left
bg-color String "#fff" Drawer container background color
cover-opacity Number 0.5 Drawer background layer opacity
disable-close-button Boolean false Hide close button
media-query String "(max-width: 640px)" Enable drawer conditional
z-index Number 1000 Drawer z-index
is-button Boolean false Add WAI-ARIA role button attribute to close icon

GitHub