Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

vuejs-carousel

ludo23719MIT0.6.0

Complete photo carousel build with VueJS and web standards in mind

carousel, vuejs, photo, photo gallery, gallery, light box

readme

npm version Downloads License

Code Climate Test Coverage Issue Count

bitHound Overall Score bitHound Dependencies bitHound Dev Dependencies bitHound Code

VueJs Carousel Awesome Vue

Easy to use VueJS component for Photo galleries, built with VueJS and web standards in mind

How to install

In order to use the carousel you have to follow 3 simple steps:

  • Install the package from npm npm install vuejs-carousel --save
  • Go into your Vue main file or main javascript file
  • Import the carousel import {store, Photos, Theater} from "vuejs-carousel"
  • Add the component inside your views

How to use

This carousel is pretty easy to use. Put the source code inside your page:

 <script src="dist/example.js"></script>

Add the components to your page like the example:

<div id="your-application-id">
    <photos source="https://www.mockaroo.com/8e9a75b0/download?count=10&key=e2db8d80"></photos>
    <theater></theater>
</div>

Try it with a source, for example you can use Mockaroo

Configuration

The current state of the component uses an array of photos objects and it expects this attributes:

  • id
  • thumbnail
  • photo
  • name
  • body
  • created_at
  • comments array
    • id
    • name
    • body
    • created_at

Be Aware: If you have a different API structure you have to change the code a little bit in particular you have to change the attributes of selectedPhoto and of photos. I will try to make this as dynamic as possible soon...

The source of the API is provided by Mockaroo

Contributing

If you want to contribute to this project issues and pull requests are welcome! In order to get started with the code you should:

  • Either download or clone this repository
  • Run npm install this will install all the necessary dependencies
  • Run npm run dev
  • Start coding :smile:

License

See License file for further details.

Changelog

See Changelog File for further details.

changelog

Change Log

All notable changes to this project will be documented in this file.

[0.5.0]

Added

  • Add new Comment component
  • Add new Comments component
  • Add comments component to Theater component
  • Add new moment.js dependency

Changed

  • Change dist name from "carousel.js" to "example.js" in order to separate example from the source
  • Improve import system for distributing the package with npmjs
  • Improve Photo component
  • Improve Theater component DOM tree
  • Improve Theater component flexbox system
  • Improve README and general documentation

Removed

  • Remove vue instance from carousel.js

[0.4.3]

Added

  • Add new action file for the Vuex store.
  • Add new "hot to install" section inside readme
  • Add new Axios library for HTTP calls
  • Add new "Contributing guidelines" section inside readme

[0.4.2]

Added

  • previousPhotoOfIndex mutation
  • nextPhotoOfIndex mutation

Changed

  • Improve theater nextPhoto and previousPhoto methods
  • Add new fancy comments

Fixed

  • Fix changeSelectedPhoto not working correctly with undefined variables

[0.4.1]

Fixed

  • Fix a problem on changeSelectedPhoto mutation

[0.4.0] - 27-12-2016

Added

  • Add new Photo component
  • Add new badge on index.html

Changed

  • Optimize Theater component
  • Improve the changeSelectedPhoto function on vuex
  • Improve code quality in order to have some standards across the source code

Removed

  • Remove index as second parameter to change the Photo

[0.3.0] - 23-12-2016

Added

  • Add Vuex ad dependency
  • Add a new folder that contains the store system built with Vuex
  • Add components name
  • Add Type on components properties

Changed

  • Improve the quality of the components with a complete refactor

Fixed

  • Fix typo on readme

Removed

  • Remove useless spacing inside the files
  • Remove the old shared events handler

[0.2.1] - 07-12-2016

Fixed

  • Fix a problem with npmjs.org sync

[0.2.0] - 07-12-2016

Added

  • Add Theater component
  • Add Photos component
  • Add new live demo with Bulma CSS framework

Removed

  • Remove PhotoGallery component
  • Remove old live demo

Fixed

  • Fix position of Theater component

[0.1.0] - 29-11-2016

Added

  • Add first version of the carousel component
  • Add simple example
  • Add Readme
  • Add this changelog
  • Add package.json file

Changed

  • Change the example file to respect the new structure of the carousel

Fixed

Removed

  • Remove old file structure and source code