z-image-preview

A TypeScript image preview package.

Install

npm install z-image-preview

Usage

import { ImagePreview } from 'z-image-preview'

const preview = new ImagePreview({
  container: document.querySelector<HTMLDivElement>('#preview')!,
  url: ['/image-1.jpg', '/image-2.jpg'],
  zoom: true,
  move: true,
  fit: 'cover',
  minScale: 0.5,
  maxScale: 6
})

preview.rotate(90)

Options

interface ImagePreviewOptions {
  container: HTMLDivElement
  url?: string | string[]
  zoom?: boolean
  move?: boolean
  fit?: 'contain' | 'cover'
  minScale?: number
  maxScale?: number
}

zoom and move default to true. fit defaults to cover. minScale defaults to 0.2, and maxScale defaults to 8.

Publish

pnpm run build
npm publish