Skip to content

jeremyhamm/vue-slider

Repository files navigation

Vue Slider

A customizable horizontal slide menu for VueJs 2+

Demo Image


Installation

NPM
  npm i @jeremyhamm/vue-slider

Browser

<script src="https://unpkg.com/@jeremyhamm/vue-slider"></script>

Usage

Mount with global

import Vue from 'vue'
import Slider from '@jeremyhamm/vue-slider'

Vue.use(Slider)

Mount with component

import Slider from '@jeremyhamm/vue-slider'

export default {
  components: {
    'slider': Slider
  }
}

Use in component

 <slider :width="300" format="push" direction="left" :opacity="0.15" :links="[{'id': 1, 'text': 'Link 1', 'url': 'https://github.com'}, {'id': 2, 'text': 'Link 2', 'url': 'https://github.com'}]"></slider>

Properties

Name Type Default Options
width Number 300 Menu Width (px)
format String overlay push, full, overlay
direction String left left, right
opacity Number 0 0.00 - 1.00 Representing css opacity
links Array null [{'id': 1, 'text': 'Link 1', 'url': 'https://github.com'}, {'id': 2, 'text': 'Link 2', 'url': 'https://github.com'}]
customStyles Object {} {'navMenu': {'background-color': 'black'}, 'navIcon': {'color': 'blue'}}

Styles

All menu styles can be updated in /assets/sass/variables.scss