Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Angular 2: How Do I Get a Reference to the Window Object?

DZone's Guide to

Angular 2: How Do I Get a Reference to the Window Object?

Remember the $window object in Angular 1? Turned out to be quite useful from now and then. But what about Angular 2? $window doesn't exist there. What's the alternative? How can I inject the Window object into my Angular 2 components? Find out here!

· Web Dev Zone ·
Free Resource

Learn how error monitoring with Sentry closes the gap between the product team and your customers. With Sentry, you can focus on what you do best: building and scaling software that makes your users’ lives better.

Remember the $window object in Angular 1? Turned out to be quite useful from now and then. But what about Angular 2? $window doesn't exist there. What's the alternative? How can I inject the Window object into my Angular 2 components?

Referencing global browser objects like document or window directly from within your code is possible, but not encouraged and considered bad practice.

Especially since Angular 2 isn’t only designed to run within your browser, but also on mobile, the server or web workers where objects like window may not be available.

Therefore the suggested approach is to wrap such objects and inject them through the dependency injection mechanism. This way it is possible to change the concrete runtime instance of a given object based on the environment the Angular application is running. The result we wanna achieve is the following:

...
import { WindowRef } from './WindowRef';

@Component({...})
class MyComponent {

    constructor(private winRef: WindowRef) {
        // getting the native window obj
        console.log('Native window obj', winRef.nativeWindow);
    }

}

So let’s see.

Wrapping window

A very straightforward and easy way to wrap window is by creating an Angular 2 service. That’s as easy as creating an ES6 class and decorating it with @Injectable.

import { Injectable } from '@angular/core';

function _window() : any {
   // return the global native browser window object
   return window;
}

@Injectable()
export class WindowRef {
   get nativeWindow() : any {
      return _window();
   }
}

Register WindowRef as Provider

Great, so far we’ve wrapped our window object. We aren’t ready yet, however. We first need to register our injectable service. This is done by registering it on the NgModule’s providers array or directly on the component, based on the scope of our provider. Check out the official docs on providers for more details.

import { WindowRef } from './WindowRef';

...

@NgModule({
    ...
    providers: [ WindowRef ]
})
export class AppModule{}

Try It Yourself

Great, we’re ready. You can now inject the WindowRef into your Angular 2 components and get access to the native window object.

Here’s a Plunker to play around with:

https://plnkr.co/edit/9qmBCVrmBZj3mPQjM0Zc?p=preview

You want to register only events on window or document? Then you may want to read this also:

http://juristr.com/blog/2016/09/ng2-event-registration-document/

What’s the best way to boost the efficiency of your product team and ship with confidence? Check out this ebook to learn how Sentry's real-time error monitoring helps developers stay in their workflow to fix bugs before the user even knows there’s a problem.

Topics:
angular ,object ,dependency injection ,window

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}