A zoom area for Ionic 2

IMPORTANT: Versions 1.0.12 and 1.0.13 will not work as expected, please use <=1.0.11 or >=1.0.14 instead.

A zoom area component with pinch support to zoom any element in page

To see this in action, checkout the example project here.

IMPORTANT: This module requires Angular Animations and should be included in the app module.

• Quick Example
• Installation
• Usage
  • zoom-area Component
• Examples

Quick Example

<zoom-area>
  <div>
      zoom it
  </div>
  or
  <img src="zoom-it.jpg" alt="zoom it">
</zoom-area>

Installation

Add Angular Animations

npm i --save @angular/animations

Import BrowserAnimationsModule in your app's module(s)

import { BrowserAnimationsModule } from '@angular/platform-browser/animations';

And then

imports: [
  ...
  BrowserAnimationsModule,
  ...
]

Install the module via NPM

npm i --save ionic2-zoom-area

Import it in your app's module(s)

Import ZoomAreaModule.forRoot() in your app's main module

import { ZoomAreaModule } from 'ionic2-zoom-area';

@NgModule({
    ...
    imports: [
      ...
      ZoomAreaModule.forRoot()
    ],
    ...
})
export class AppModule {}

If your app uses lazy loading, you need to import ZoomAreaModule in your shared module or child modules:

import { ZoomAreaModule } from 'ionic2-zoom-area';

@NgModule({
    ...
    imports: [
      ...
      ZoomAreaModule
    ],
    ...
})
export class SharedModule {}

Usage

zoom-area Component

Inputs

scale

(optional) (two-way) The scale of your initial zoom. Defaults to 1.

controls

(optional) (two-way) It allow you to hide or show zoom controls. Defaults to true.

Outputs

afterZoomIn

Listen to this event to be notified when the user interact with zoom in.

afterZoomOut

Listen to this event to be notified when the user interact with zoom out.

ZoomAreaProvider Provider

notifyScroll

notifyScroll(): void

It broadcast an event when user scroll content inside zoom area.

onScroll$

onScroll$: Observable

It allows you to listen for a scroll event inside your zoom area. You can use it to collapse you header for example.

this.zoomAreaProvider.onScroll$.subscribe(state => {
  if (state === this.zoomAreaProvider.SCROLL_STATE.COLLAPSED) {
    console.log('Hide header');
  }

  if (state === this.zoomAreaProvider.SCROLL_STATE.EXPANDED) {
    console.log('Show header');
  }
});

scrollState$

scrollState$: Observable

It allows you to listen for a change in scroll state.

this.zoomAreaProvider.scrollState$.subscribe(state => {
  console.log('Do whatever you want when scrollState change');
});

setCenter (x: number, y: number)

setCenter: Function

It allows you to change the position of the zoom manually if zoom scale is greather than 1.

this.zoomAreaProvider.setCenter(x, y);
this.zoomAreaProvider.setCenter(20, 50);

Examples

Basic example

Example with methods

<zoom-area [(scale)]="scale" (afterZoomIn)="afterZoomIn($event)" (afterZoomOut)="afterZoomOut($event)" [(controls)]="showControls">
    <div>Zoom It</div>
    or
    <img src="assets/image-to-zoom.jpg" alt="Zoom It">
</zoom-area>

Known Issues 🤬

• ✅(Fixed in 1.0.12) Vertical pan is in conflict with scroll event and are not fired like horizontal pan.

Roadmap

• ✅(Fixed in 1.0.10) - Add support to move center of zoom

Contribution

• Having an issue? or looking for support? Open an issue and we will get you the help you need.
• Got a new feature or a bug fix? Fork the repo, make your changes, and submit a pull request.

Support this project

If you find this project useful, please star the repo to let people know that it's reliable. Also, share it with friends and colleagues that might find this useful as well. Thank you :smile: