Skip to content

sunilkum84/vue-carousel

This branch is up to date with JonathanMH/vue-carousel:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

1e92ba9 · Jul 18, 2017

History

88 Commits
Dec 29, 2016
Jun 16, 2017
Jul 18, 2017
Mar 3, 2017
Jun 16, 2017
Jun 16, 2017
Dec 28, 2016
Jan 12, 2017
Jan 5, 2017
Jan 3, 2017
Jan 5, 2017
Jan 3, 2017
Jan 3, 2017
Jan 31, 2017
Jun 16, 2017
Feb 10, 2017

Repository files navigation

Vue Carousel

Build Status Coverage Status Latest Stable Version

WARNING: vue-carousel is at pre-alpha stage of development and may undergo significant changes.

Feel free to submit issues and feature requests here.

Full documentation and examples

Table of Contents

Installation

npm install -S vue-carousel

Usage

Global

You may install Vue Carousel globally:

import Vue from 'vue';
import VueCarousel from 'vue-carousel';

Vue.use(VueCarousel);

This will make <carousel> and <slide> available to all components within your Vue app.

Local

Include the carousel directly into your component using import:

import { Carousel, Slide } from 'vue-carousel';

export default {
  ...
  components: {
    Carousel,
    Slide
  }
  ...
};

HTML Structure

Once the Carousel and Slide components are installed globally or imported, they can be used in templates in the following manner:

  <carousel>
    <slide>
      Slide 1 Content
    </slide>
    <slide>
      Slide 2 Content
    </slide>
  </carousel>

Development

A sandboxed dev environment is provided by vue-play. Changes made to the component files will appear in real time in the sandbox.

To begin development, run:

npm install
npm run dev

then navigate to http://localhost:5000

To modify and add sandbox scenarios, edit play/index.js

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

About

A flexible, responsive, touch-friendly carousel for Vue.js

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 53.0%
  • Vue 47.0%