1.1.0 • Published 4 years ago

vue-ultra-sidenav v1.1.0

Weekly downloads
44
License
-
Repository
github
Last release
4 years ago

vue-ultra-sidenav

Implement a customizable sidenav component.

Install

npm install --save vue-ultra-sidenav

Import components

import {
  Sidenav,
  SidenavLink,
  SidenavOption,
  SidenavGroup
} from 'vue-ultra-sidenav';

Basic usage

A propertie can define if sidenav is open or not. When Close button or backdrop (is used) is clicked then close event is emitted.

<template>
  <sidenav
    :is-open="isOpenSidenav"
    @close="closeSidenav"
  >
    <sidenav-group title="Info Group">
      <sidenav-option
        @click="$router.push('/')"
      >
        Go Home
      </sidenav-option>
    </sidenav-group>

    <sidenav-group title="Links">
      <sidenav-link
        :url="'https://google.com'"
        :target="'blank'"
      >
        Google
      </sidenav-link>
      <sidenav-link
        :url="'https://github.com'"
        :target="'blank'"
      >
        Github
      </sidenav-link>
    </sidenav-group>
  </sidenav>
</template>

<script>
export default {
  name: 'sidenav',
  data() {
    return {
      isOpenSidenav: true
    };
  },
  methods: {
    closeSidenav() {
      this.isOpenSidenav = false;
    }
  }
};
</script>

Props and events definition

Sidenav

PropTypeDefaultDescription
isOpenbooleanfalseDefines if sidenav is open or not
backdropbooleantrueDefines if backdrop is used or not
transitionstring (Name of css transition)fade (Defined on internal css)Set css animation to open and close event
closeIconstring (Path to proyect image)null (Internal icon is used)Send icon to use on close button
fixLeftbooleantrueFix to ledt side

Contribution

All pull requests and suggestions are welcome.

1.1.0

4 years ago

1.0.2

4 years ago

1.0.1

5 years ago

1.0.0

5 years ago