Angular Window Component

The Window component for Angular directs a user's attention to a particular activity in your application, such as entering data or viewing information. Consider using a jQWidgets Window when you want greater customization, you want to block the user interface outside the window, or when you want to retrieve a DialogResult and other data from the popup window. jQWidgets Window can be displayed as a modal dialog window that blocks user interaction with the underlying user interface or as a standard window without blocking the web page's user interface.

Prerequisites

Refer to Angular Getting Started before you start with this help topic.

Configuration

I. Imports

The Window component for Angular requires the following imports.

II. @Component Decorator

A class is marked as an Angular component through the @Component decorator:

selector - css selector that identifies this component in a template
styles - inline-defined styles to be applied to this component's view
styleUrls - list of urls to stylesheets to be applied to this component's view
template - inline-defined template for the view
templateUrl - url to an external file containing a template for the view

The full list of @Component decorator properties is available on: Angular @Component Decorator API

Every jQWidgets Angular component has an [auto-create] attribute which determines whether the component is automatically created or is created on demand by API method call.
By default, the [auto-create] attribute value is true.

III. Create the AppComponent class

The AppComponent class is used to instantiate the app. In some of the examples, we use @ViewChild and ngAfterViewInit.

@ViewChild: makes a reference using a Window selector. ViewChild is used to get the first element matching the selector from the view DOM. If the view DOM changes, and a new child matches the selector, the property will be updated. View queries are set before the ngAfterViewInit callback is called.
@ViewChild('navBarReference') myWindow: jqxWindowComponent;
ngAfterViewInit - this is an Angular Component Lifecycle method in which we create our angular components. After the view is initialized, myWindow is available.
For more information about this methods please refer to Angular Component Lifecycle API

The following example demonstrates the Window component for Angular.

app.component.htm

app.component.ts

Run Code

IV. Create Window component with JSON

Add the imports.
import { Component, ViewChild, AfterViewInit } from '@angular/core';
import { jqxWindowComponent } from 'jqwidgets-ng/jqxwindow';
@Component decorator:
```
@Component({
    selector: 'app-root',
    template: `<jqxWindow #navBarReference></jqxWindow>`
})
```
Create the AppComponent class.
- @ViewChild: makes a reference using a Window selector. ViewChild is used to get the first element matching the selector from the view DOM. If the view DOM changes, and a new child matches the selector, the property will be updated. View queries are set before the ngAfterViewInit callback is called.
```
@ViewChild('navBarReference') myWindow: jqxWindowComponent;
```
- ngAfterViewInit: All Angular components have an integrated method called createComponent that accept a JSON object with the component initialization properties. If no argument is passed, default properties will be used. If you would like to dynamically set properties after creation, you can use the setOptions method.
```
ngAfterViewInit(): void
{
    this.myWindow.createComponent(this.WindowSettings);
}
```
The following example demonstrates how to create a Window component for Angular by using the createComponent method.

Properties

The properties which are defined as attributes can be changed directly:

To get or set a property, which we did not define or call a method, we can do the following:

Import @ViewChild decorator:
Add the Window component:
Get access to the Window component and its API:
Finally, we can call methods or set/get properties like that:

Every component have a method setOptions which accepts a JSON object as an argument. This object contains component settings and you can use it to set a single or multiple properties dynamically.

Events

The open event is triggered when the window is displayed.

The following example demonstrates how to add an event listener.

Note: Event Names of the Window component for Angular are the same as the Event Names of the jqxWindow widget.
The only thing you need to do is to put "on" before the event name and upperCase it's first letter.

Methods

To invoke methods, you can use the Window reference.
( open() to open the widget ) - this.myWindow.open().

The following example demonstrates how to invoke methods of the Window component for Angular.

Window Examples

Overview

The following example demonstrates how to create a Window component for Angular.

Disabling

The following example demonstrates how to disable the Window component for Angular.

Window API

API Reference of the jQWidgets Window component for Angular: Window API