Skip to main content

antd_image_viewer 1.0.0 copy "antd_image_viewer: ^1.0.0" to clipboard
antd_image_viewer: ^1.0.0 copied to clipboard

Ant Design (antd-mobile) ImageViewer component for Flutter. Full-screen image preview with pinch zoom, pan, double-tap zoom, multi-image paging and controlled open/close, aligned with antd-mobile Imag [...]

antd_image_viewer - Fullscreen image viewer with zoom and paging #

English | 简体中文

antd_image_viewer is a Flutter port of antd-mobile's ImageViewer / MultiImageViewer: a fullscreen dark overlay with pinch zoom, pan, double-tap zoom, horizontal paging between images, a page counter, a close button and a controlled open state.

It is a display component, not a camera or a gallery grid. You give it a list of image sources and an open flag; it inserts itself into the root overlay, and the host keeps ownership of the flag through onClose. Network images are loaded through cached_network_image; anything whose source does not start with http is treated as an asset.

Positioning & design #

Aspect Decision
Presentation Root OverlayEntry, full-screen Material barrier at 85% black, 200 ms fade in/out
Host contract open is fully controlled; the viewer never flips it itself and calls onClose instead
Paging PageView.builder, one image per page, counter n / total
Zoom InteractiveViewer bounded by maxZoomRatio; double tap toggles between 1× and maxZoomRatio
Image loading cached_network_image for http… sources, Image.asset otherwise, shared placeholder/error widgets
Dismissal Close button, single tap at 1×, and the Escape key

Installation #

Requires Dart >=3.0.0 and Flutter >=3.10.0. Network images require platform network permission as usual; local images must be declared in your app's pubspec.yaml assets.

dependencies:
  antd_image_viewer: ^1.0.0

Inside this monorepo:

dependencies:
  antd_image_viewer:
    path: ../packages/antd_image_viewer

Quick start #

import 'package:antd_image_viewer/antd_image_viewer.dart';
import 'package:antd_theme/antd_theme.dart';
import 'package:material_ui/material_ui.dart';

void main() => runApp(const ViewerApp());

class ViewerApp extends StatefulWidget {
  const ViewerApp({super.key});

  @override
  State<ViewerApp> createState() => _ViewerAppState();
}

class _ViewerAppState extends State<ViewerApp> {
  bool _open = false;

  @override
  Widget build(BuildContext context) {
    return AntTheme(
      data: AntThemeData.light(),
      child: MaterialApp(
        home: Scaffold(
          body: Center(
            child: AntImageViewer(
              images: const [
                'https://picsum.photos/id/1015/1200/800',
                'https://picsum.photos/id/1016/1200/800',
                'https://picsum.photos/id/1018/1200/800',
              ],
              open: _open,
              onClose: () => setState(() => _open = false),
              afterClose: () => debugPrint('viewer closed'),
            ),
          ),
          floatingActionButton: FloatingActionButton(
            onPressed: () => setState(() => _open = true),
            child: const Icon(Icons.image_outlined),
          ),
        ),
      ),
    );
  }
}

The widget itself occupies no space (SizedBox.shrink); the visible UI lives in the root overlay.

API #

API reference

Open the viewer at a specific image:

AntImageViewer(
  images: const [
    'https://picsum.photos/id/1015/1200/800',
    'https://picsum.photos/id/1016/1200/800',
  ],
  defaultIndex: 1,
  open: true,
  onClose: () {},
)

Limit the zoom range and disable double-tap zoom:

AntImageViewer(
  images: const ['https://picsum.photos/id/1015/1200/800'],
  open: true,
  maxZoomRatio: 5,
  enableCompositeZoom: false,
  onClose: () {},
)

Run cleanup work after the closing animation has finished:

AntImageViewer(
  images: const ['https://picsum.photos/id/1015/1200/800'],
  open: true,
  onClose: () {},
  afterClose: () => debugPrint('overlay removed'),
)

Demo #

Project structure #

antd_image_viewer/
├── lib/
│   ├── antd_image_viewer.dart                  # Public barrel
│   └── src/image_viewer/
│       ├── ant_image_viewer.dart               # Overlay viewer + zoomable page
│       └── ant_image_viewer_types.dart         # Defaults and shared builders
├── example/lib/main.dart                       # Demo gallery
├── test/ant_image_viewer_test.dart             # Widget tests
├── docs/api-index.md
├── README.md
├── README_CN.md
├── CHANGELOG.md
└── pubspec.yaml

License #

MIT. See the repository root LICENSE.

☕ Buy Me a Coffee #

If this project has been helpful to you, you are welcome to buy me a coffee. Thank you for your support!

Alipay WeChat
Alipay QR code WeChat QR code
1
likes
0
points
0
downloads

Publisher

unverified uploader

Weekly Downloads

Ant Design (antd-mobile) ImageViewer component for Flutter. Full-screen image preview with pinch zoom, pan, double-tap zoom, multi-image paging and controlled open/close, aligned with antd-mobile ImageViewer API.

Homepage
Repository (GitHub)
View/report issues

Topics

#ui #components #design-system #ant-design #image-viewer

License

unknown (license)

Dependencies

antd_icons_flutter, antd_theme, cached_network_image, flutter, material_ui

More

Packages that depend on antd_image_viewer