1.0.5 • Published 4 years ago

shapla-dashboard-layout v1.0.5

Weekly downloads
5
License
MIT
Repository
github
Last release
4 years ago

shapla-dashboard-layout

A simple dashboard layout to build your app dashboard. for Vue.js

Table of contents

Installation

npm i shapla-dashboard-layout

Usage

Add the component:

import dashboardLayout from 'shapla-dashboard-layout';

export default {
    name: 'Hello',

    components: {
        dashboardLayout
    },

    data() {
        return {
            activateSideNav: false,
        }
    },

    computed: {
        menuItems() {
            return Array.from({length: 50}, (x, i) => i + 1);
        }
    }

}
<dashboard-layout
    title="Dashboard"
    :activate-side-nav="activateSideNav"
    @open:sidenav="activateSideNav = true"
    @close:sidenav="activateSideNav = false"
    user-display-name="Sayful Islam"
    avatar-url="https://s.gravatar.com/avatar/5ba82fcf5f7f8b24097ff9f7ad4b3d5b?s=80"
    greeting="Hello,"
>
    <template v-slot:sidenav-menu>
        <ul class="sidenav-list">
            <li class="sidenav-list__item" v-for="number in menuItems">
                <a class="sidenav-list__link" href="#">Menu item {{number}}</a>
            </li>
        </ul>
    </template>

    <p v-for="number in menuItems">{{number}}. Dashboard Content will go here</p>
</dashboard-layout>

Props

PropertyTypeRequiredDefaultDescription
activateSideNavBooleannofalseBoolean value hide/show sidenav
titleStringno | Dashboard title
userDisplayNameStringno | User display name
avatarUrlStringno | User avatar url
greetingStringnoHello,Greeting text
headerHeightStringno56pxHeight of header
headerThemeStringnoprimaryValue can be default or primary or secondary
navWidthStringno300pxWidth of side navigation
sideNavTypeStringnooverlayValue can be overlay or off-canvas. off-canvas is experimental
showOverlayBooleannotrueShould show overlay color when side navigation active.

Listeners

The dashboard layout component fires the following events:

open:sidenav: When burger icon is clicked, it fires the event.

close:sidenav: When outside of sidenav is clicked, it fires the event.

<!-- template -->
<dashboard-layout @open:sidenav="handleOpenSidenav" @close:sidenav="handleCloseSidenav"></dashboard-layout>


<!-- method -->
methods: {
  handleOpenSidenav(){
    // Handle click event
  },
  handleCloseSidenav(){
    // Handle click event
  }
}
1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago