Skip to content

README_en.md

Latest commit

 

History

History
105 lines (67 loc) · 2.36 KB

README_en.md

File metadata and controls

105 lines (67 loc) · 2.36 KB
Raw

LBJImagePreviewer

LBJImagePreviewer is an image previewer implemented with SwiftUI.

Features

  • Zoom with magnification gesture
  • Double click to zoom in/out
  • Supports gif images

Preview

preview

Installation

LBJImagePreviewer can be installed using Swift Package Manager:

  1. Copy the package URL:
https://github.com/Lebron1992/LBJImagePreviewer

  1. Open the menu File / Add Packages in Xcode.

  2. Paste the URL to the search box and add the library to your project.

Usage

UIImage

Preview UIImage：

let uiImage = UIImage(named: "lebron")!
LBJUIImagePreviewer(uiImage: uiImage)

Image

Preview Image：

// the width/height ratio of `Image` is needed
LBJImagePreviewer(content: Image(uiImage: uiImage), aspectRatio: 2 / 3)

Gif images

Preview gif images：

LBJGIFImagePreviewer(imageNamed: "lebron")

if let url = Bundle.main.url(forResource: "lebron", withExtension: "gif"),
   let data = try? Data(contentsOf: url) {
  LBJGIFImagePreviewer(imageData: data)
}

Any View

If you don't preview an image with UIImage or Image, you could preview any View. For example, we preview a red background:

LBJViewZoomer<Color>(content: .red, aspectRatio: 1)

Double-Tap Scale

You can specify the scale(3 by default) for double-tap to zoom in:

LBJUIImagePreviewer(uiImage: uiImage, doubleTapScale: 5)
LBJImagePreviewer(content: Image(uiImage: uiImage), aspectRatio: 2 / 3, doubleTapScale: 5)

Max Scale

Also you can specify the max scale(16 by default):

LBJUIImagePreviewer(uiImage: uiImage, maxScale: 20)
LBJImagePreviewer(content: Image(uiImage: uiImage), aspectRatio: 2 / 3, maxScale: 20)

Reset Scale On Disappear

Sets wheather reset the scale on disappear, true by default:

LBJUIImagePreviewer(uiImage: uiImage, maxScale: 20)
  .resetScaleOnDisappear(true)
LBJImagePreviewer(content: Image(uiImage: uiImage), aspectRatio: 2 / 3, maxScale: 20)
  .resetScaleOnDisappear(false)

Existing Issues

  • When you double-click to zoom in, the image can ONLY be zoomed in from the middle, not at the click location. (Currently, we can't set contentOffset for ScrollView manually, so we have to wait for the ScrollView updates to solve the issue.)

Requesting a Feature

Use GitHub issues to request a feature.