0.0.5 • Published 8 years ago

wovue-offcanvas v0.0.5

Weekly downloads
7
License
ISC
Repository
github
Last release
8 years ago

Offcanvas

Deprecated, use wovue-off-canvas instead.

The wovue-offcanvas module contains the offcanvas component. You can add multiples offcanvas and offcanvas-wrapper.

Install using npm:

$ npm install --save wovue-offcanvas

Note this will only works with webpack build system.

Usage

import { WvOffcanvas, WvOffcanvasButton, WvOffcanvasWrapper } from 'wovue-offcanvas'

new Vue({
  components: {
    WvOffcanvas,
    WvOffcanvasButton,
    WvOffcanvasWrapper
  }
})
<wv-offcanvas ref="menu" wrapper-ref="main" align="right" :width="300">
  <wv-offcanvas-button offcanvas-ref="menu" >Toggle menu offcanvas</wv-offcanvas-button>
  <!-- here offcanvas content -->
</wv-offcanvas>
<wv-offcanvas-wrapper ref="main">
  <wv-offcanvas-button offcanvas-ref="menu" >Toggle menu offcanvas</wv-offcanvas-button>
  <!-- here your content -->
</wv-offcanvas-wrapper>

Props

offcanvas-wrapper

NameTypeDefaultDescription
refString(required)A unique identifier for the offcanvas-wrapper.
showOverlayBooleantrueShow the overlay or no. Click over the overlay will close the current offcanvas.
pushBooleantruePush content if it is true.
modifierString, BooleanfalseModifier class name for custom style rules.

offcanvas

NameTypeDefaultDescription
refString(required)A unique identifier for the offcanvas.
wrapperRefString(required)Offcanvas wrapper reference.
alignString'left'Offcanvas position. The support align values are left and right.
widthNumber300Offcanvas width.
modifierString, BooleanfalseModifier class name for custom style rules.

offcanvas-button

NameTypeDefaultDescription
offcanvasRefString(required)Offcanvas reference.
0.0.5

8 years ago

0.0.4

8 years ago

0.0.3

8 years ago

0.0.2

8 years ago

0.0.1

8 years ago