DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
  1. DZone
  2. Coding
  3. Frameworks
  4. Angular 2: How Do I Get a Reference to the Window Object?

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!

Juri Strumpflohner user avatar by
Juri Strumpflohner
·
Sep. 22, 16 · Tutorial
Like (2)
Save
Tweet
Share
74.38K Views

Join the DZone community and get the full member experience.

Join For Free

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/

Object (computer science) AngularJS

Published at DZone with permission of Juri Strumpflohner. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Key Considerations When Implementing Virtual Kubernetes Clusters
  • Remote Debugging Dangers and Pitfalls
  • Why It Is Important To Have an Ownership as a DevOps Engineer
  • Taming Cloud Costs With Infracost

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: