Skip to content
This repository has been archived by the owner on Sep 24, 2024. It is now read-only.

Latest commit

 

History

History
83 lines (59 loc) · 3.4 KB

README.md

File metadata and controls

83 lines (59 loc) · 3.4 KB

Vue Compare Image

All Contributors

Simple Vue.js component to compare two images using slider.

img

NOTE: React Version is also available!

Demo

DEMO

Features

  • Simple
  • Responsive (fit to the parent width)
  • Size difference between two images handled correctly. Element size determined by following two factors:
    • width of the parent
    • right image's aspect ratio

How to use

In the shell:

yarn add vue-compare-image

// or

npm install --save vue-compare-image

In your component file:

import VueCompareImage from 'vue-compare-image';

export default {
  name: 'app',
  components: { VueCompareImage },
};
<template>
  <VueCompareImage leftImage="image1.jpg" rightImage="image2.jpg" />;
</template>

Props

Prop (* required) type default description
handleSize number (px) 40 diameter of slider handle (by pixel)
hover boolean false Whether to slide at hover
leftImage * string null left image's url
leftImageAlt string null left image's alt
leftLabel string null Left image text label
rightImage * string null right image's url
rightImageAlt string null right image's alt
rightLabel string null Right image text label
sliderLineWidth number (px) 2 line width of slider (by pixel)
sliderPositionPercentage number (float) 0.5 Starting line position (from 0 to 1)

Dependencies

Contributors

Shota Tamura
Shota Tamura

💻
Lukáš Irsák
Lukáš Irsák

💻
Ricardo Morin
Ricardo Morin

💻