0.0.3 • Published 11 months ago

vue3-image-carousel-component v0.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

This project is licensed under the MIT License.

Installation

npm i vue3-image-carousel-component

or

yarn add vue3-image-carousel-component

Usage

import {VCarousel} from 'vue3-image-carousel-component' <br>
import 'vue3-image-carousel-component/dist/style.css';

Props

The following table describes the props that can be passed to the component for customization:

PropTypeDescription
imagesStringYour Image array will be inside of images.
backButtonWidthStringThe Width of back button.
nextButtonWidthStringThe Width of back button.
backButtonHeightStringThe Height of back button.
nextButtonHeightStringThe Height of next button.
arrowsColorStringThe color of the button.
slideWidthStringThe width of slide.
slideHeightStringThe height of slide.
mainDivDisplayStringChoose your display type default flex.
mainDivAlignItemsStringAlign items type default center.
imageWidthStringThe width of image default 100%.
imageHeightStringThe width of image default 100%.
objectFitCoverStringChoose your fit default Cover

Example

<template>
const carouselImages = [
  "https://exampleImageOne",
  "https://exampleImageTwo",
  "https://exampleImageThree"
]
  <Carousel 
    :images=  "carouselImages"
    slideWidth="1000px"
    slideHeight="500px"
    backButtonWidth="100px"
    backButtonHeight="100px"
    nextButtonWidth="100px"
    nextButtonHeight="100px"
    arrowsColor="red" 
    mainDivDisplay="flex" 
    mainDivAlignItems="center" 
    imageWidth="100%" 
    imageHeight="100%" 
    objectFitCover="Cover"
    >
  </Carousel>
</template>

<script>
import { VCarousel } from 'vue3-image-carousel-component';
## Props

License

This project is licensed under the MIT License.