Skip to content

ChristianKohler/ng-resize-observer

Repository files navigation

Angular Resize Observer

Installation

npm install ng-resize-observer

Usage

import {
  NgResizeObserver,
  ngResizeObserverProviders
} from "ng-resize-observer";

@Component({
  ...
  // 1. Add providers
  providers: [...ngResizeObserverProviders]
})
export class AppComponent {
  // 2. Inject resize$
  constructor(private resize$: NgResizeObserver) {}
}

Example

import { Component } from "@angular/core";
import {
  NgResizeObserver,
  ngResizeObserverProviders,
} from "ng-resize-observer";
import { map } from "rxjs/operators";

@Component({
  selector: "app-root",
  template: "width is {{ width$ | async }} px",
  styles: [
    `
      :host {
        display: block;
        border: 3px solid green;
      }
    `,
  ],
  providers: [...ngResizeObserverProviders],
})
export class AppComponent {
  width$ = this.resize$.pipe(map((entry) => entry.contentRect.width));

  constructor(private resize$: NgResizeObserver) {}
}

Ponyfill

The ponyfill https://github.com/juggle/resize-observer is not bundled by default.

To include the bundle, use either

providers: [...ngResizeObserverProvidersWithPonyfill];

on every component. Or import it once in a module:

@NgModule({
    imports: [NgResizeObserverPonyfillModule]
})

Warning

Angular does not zone patch resize-observer. Nor does this library. This means that change detection is not triggered in certain async situations. To be safe its recommended to add the zone patch for resize-observer in your polyfill.ts.

// polyfill.js
import "zone.js/dist/zone-patch-resize-observer";

Prefer a directive over a observable?

Check out: https://www.npmjs.com/package/ngx-resize-observer