Vue carousel cm

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

Version: 0.6.5 Updated: 01/28/2018

By: jessemao License: MIT

Downloads Last 30 Days: 12

Install

npm i vue-carousel-cm
yarn add vue-carousel-cm

Repository: https://github.com/jessemao/vue-carousel

CDNs

bundle.run: https://bundle.run/vue-carousel-cm

jsDelivr: https://cdn.jsdelivr.net/npm/vue-carousel-cm

unpkg: https://unpkg.com/vue-carousel-cm

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.

Categories: Vue js