vue-inner-image-zoom

A lightweight Vue component for magnifying an image within its original container.

Demos | Changelog

Installation

Note: Version 2.0.0 upgrades the component to support Vue 3. To use this package with older versions of Vue, install using npm install [email protected] or yarn add [email protected] instead of the instructions below.

NPM

npm install vue-inner-image-zoom

Yarn

yarn add vue-inner-image-zoom

TypeScript

Type declarations were added with version 3.0.0.

Usage

Import the component and include in your template:

import InnerImageZoom from 'vue-inner-image-zoom';

...

export default {
  components: {
    'inner-image-zoom': InnerImageZoom
  }
}

...

<inner-image-zoom src="/path/to/image.jpg" zoomSrc="/path/to/zoom-image.jpg" />

Props

Prop | Type | Default | Description --- | --- | --- | --- src | string | | (Required) URL for the original image. sources | array | | A list of image sources for using the picture tag to serve the appropriate original image (see below for more details). width | number | | Width attribute for original image. height | number | | Height attribute for original image. hasSpacer | boolean | false | If true, gets the original image's aspect ratio based on the width and height props and creates a spacer to prevent cumulative layout shift. imgAttributes | object | | Img and global attributes for the original image (excluding src, width, height, and style which are set elsewhere). zoomSrc | string | | URL for the larger zoom image. Falls back to original image src if not defined. zoomScale | number | 1 | Multiplied against the natural width and height of the zoomed image. This will generally be a decimal (example, 0.9 for 90%). zoomPreload | boolean | false | If set to true, preloads the zoom image instead of waiting for mouseenter and (unless on a touch device) persists the image on mouseleave. moveType | pan or drag | pan | The user behavior for moving zoomed images on non-touch devices. zoomType | click or hover | click | The user behavior for triggering zoom. When using hover, combine with zoomPreload to avoid flickering on rapid mouse movements. fadeDuration | number | 150 | Fade transition time in milliseconds. If zooming in on transparent images, set this to 0 for best results. fullscreenOnMobile | boolean | false | Enables fullscreen zoomed image on touch devices below a specified breakpoint. mobileBreakpoint | number | 640 | The maximum breakpoint for fullscreen zoom image when fullscreenOnMobile is true. hideCloseButton | boolean | false | Hides the close button on touch devices. If set to true, zoom out is triggered by tap. hideHint | boolean | false | Hides the magnifying glass hint. className | string | | Custom classname for styling the component. afterZoomIn | () => void | | Function to be called after zoom in. afterZoomOut | () => void | | Function to be called after zoom out.

Sources

This prop accepts an array of objects which it uses to create a picture tag and source elements. The component looks for the following optional properties and you can find additional details on responsive images here:

Prop | Type | Default | Description --- | --- | --- | --- srcSet | string | | Srcset attribute for source tag. sizes | string | | Sizes attribute for source tag. media | string | | An attribute containing a media condition for use with the srcset. type | string | | An image MIME type. This is useful for using newer formats like WebP.

Issues

Please submit bugs or requests on the GitHub issues page and make sure to use the vue label.

License

MIT