Angular 2 HostListener & HostBinding

原文

  https://www.jianshu.com/p/20c2d60802f7

大纲

  1、宿主元素(Host Element)
  2、HostListener
  3、HostListenerDecorator 装饰器应用
  4、HostBinding
  5、HostBinding 装饰器应用

宿主元素(Host Element)

  在介绍 HostListener 和 HostBinding 属性装饰器之前,我们先来了解一下 host element (宿主元素)。
  宿主元素的概念同时适用于指令和组件。对于指令来说,这个概念是相当简单的。应用指令的元素,就是宿主元素。假设我们已声明了一个 HighlightDirective 指令 (selector: ‘[exeHighlight]‘):

<p exeHighlight>
   <span>高亮的文本</span>
</p>

  上面 html 代码中,p 元素就是宿主元素。如果该指令应用于自定义组件中如:

<exe-counter exeHighlight>
    <span>高亮的文本</span>
</exe-counter>

  此时 exe-counter 自定义元素,就是宿主元素。

HostListener

  HostListener 是属性装饰器,用来为宿主元素添加事件监听。

/*
  HostListenerDecorator 装饰器定义
*/
export interface HostListenerDecorator {
    (eventName: string, args?: string[]): any;
    new (eventName: string, args?: string[]): any;
}

HostListenerDecorator 装饰器应用

/*
    counting.directive.ts
*/
import { Directive, HostListener } from ‘@angular/core‘;

@Directive({
    selector: ‘button[counting]‘
})
class CountClicks {
    numberOfClicks = 0;

    @HostListener(‘click‘, [‘$event.target‘])
    onClick(btn: HTMLElement) {
        console.log(‘button‘, btn, ‘number of clicks:‘, this.numberOfClicks++);
    }
}
/*
    app.component.ts
*/
import { Component} from ‘@angular/core‘;

@Component({
  selector: ‘exe-app‘,
  styles: [`
    button {
      background: blue;
      color: white;
      border: 1px solid #eee;
    }
  `],
  template: `
    <button counting>增加点击次数</button>
  `
})
export class AppComponent {}

/*
    以上代码运行后浏览器显示的结果:
*/

  此外,我们也可以监听宿主元素外,其它对象产生的事件,如 window 或 document 对象。具体示例如下:

/*
    highlight.directive.ts
*/
import { Directive, HostListener, ElementRef, Renderer } from ‘@angular/core‘;

@Directive({
    selector: ‘[exeHighlight]‘
})
export class ExeHighlight {
    constructor(private el: ElementRef, private renderer: Renderer) { }

    @HostListener(‘document:click‘, [‘$event‘])
    onClick(btn: Event) {
        if (this.el.nativeElement.contains(event.target)) {
            this.highlight(‘yellow‘);
        } else {
            this.highlight(null);
        }
    }

    highlight(color: string) {
        this.renderer.setElementStyle(this.el.nativeElement, ‘backgroundColor‘, color);
    }
}

/*
    app.component.ts
*/
import { Component} from ‘@angular/core‘;

@Component({
  selector: ‘exe-app‘,
  template: `
    <h4 exeHighlight>点击该区域,元素会被高亮。点击其它区域,元素会取消高亮</h4>
  `
})
export class AppComponent {}

/*
    以上代码运行后浏览器显示的结果:
*/

  我们也可以在指令的 metadata 信息中,设定宿主元素的事件监听信息,具体示例如下:

/*
    counting.directive.ts
*/
import { Directive } from ‘@angular/core‘;

@Directive({
    selector: ‘button[counting]‘,
    host: {
      ‘(click)‘: ‘onClick($event.target)‘
    }
})
export class CountClicks {
    numberOfClicks = 0;

    onClick(btn: HTMLElement) {
        console.log(‘button‘, btn, ‘number of clicks:‘, this.numberOfClicks++);
    }
}

HostBinding

  HostBinding 是属性装饰器,用来动态设置宿主元素的属性值。

/*
    HostBinding 装饰器定义
*/
export interface HostBindingDecorator {
    (hostPropertyName?: string): any;
    new (hostPropertyName?: string): any;
}

HostBinding 装饰器应用

/*
    button-press.directive.ts
*/
import { Directive, HostBinding, HostListener } from ‘@angular/core‘;

@Directive({
    selector: ‘[exeButtonPress]‘
})
export class ExeButtonPress {
    @HostBinding(‘attr.role‘) role = ‘button‘;
    @HostBinding(‘class.pressed‘) isPressed: boolean;

    @HostListener(‘mousedown‘) hasPressed() {
        this.isPressed = true;
    }
    @HostListener(‘mouseup‘) hasReleased() {
        this.isPressed = false;
    }
}

/*
    app.component.ts
*/
import { Component } from ‘@angular/core‘;

@Component({
  selector: ‘exe-app‘,
  styles: [`
    button {
      background: blue;
      color: white;
      border: 1px solid #eee;
    }
    button.pressed {
      background: red;
    }
  `],
  template: `
    <button exeButtonPress>按下按钮</button>
  `
})
export class AppComponent { }

/*
    以上代码运行后浏览器显示的结果:
*/

Host Property Bindings

  我们也可以在指令的 metadata 信息中,设定宿主元素的属性绑定信息,具体示例如下:

/*
    button-press.directive.ts
*/
import { Directive, HostListener } from ‘@angular/core‘;

@Directive({
    selector: ‘[exeButtonPress]‘,
    host: {
      ‘role‘: ‘button‘,
      ‘[class.pressed]‘: ‘isPressed‘
    }
})
export class ExeButtonPress {
    isPressed: boolean;

    @HostListener(‘mousedown‘) hasPressed() {
        this.isPressed = true;
    }
    @HostListener(‘mouseup‘) hasReleased() {
        this.isPressed = false;
    }
}

宿主元素属性和事件绑定风格指南

  优先使用 @HostListener 和 @HostBinding ,而不是 @Directive 和 @Component 装饰器的 host 属性。
  对于关联到 @HostBinding 的属性或关联到 @HostListener 的方法,要修改时,只需在指令类中的一个地方修改。 如果使用元数据属性 host,你就得在组件类中修改属性声明的同时修改相关的元数据。

参考网址

  https://segmentfault.com/a/1190000008878888

原文地址:https://www.cnblogs.com/shcrk/p/9240859.html

时间: 2024-10-02 22:22:28

Angular 2 HostListener & HostBinding的相关文章

[Angular Directive] Combine HostBinding with Services in Angular 2 Directives

You can change behaviors of element and @Component properties based on services using @HostBinding in @Directives. This allows you to build @Directives which rely on services to change behavior without the @Component ever needing to know that the Ser

[Angular 2] Directive intro and exportAs

First, What is directive, what is the difference between component and directive. For my understanding, component is something like 'canvas', 'form', 'table'... they have the template and their own functionality. It defines how a html tag should work

[Angular Directive] 3. Handle Events with Angular 2 Directives

A @Directive can also listen to events on their host element using @HostListener. This allows you to add behaviors that react to user input and update or modify properties on the element without having to create a custom component. import {Directive,

Angular4 @HostBinding @HostListener

host属性 @Component({ selector: 'jhi-project', templateUrl: './project.html', styleUrls: [], host: { '(window:keydown)': 'keyboardInput($event)' }    //绑定事件和方法 }) export class JhiProjectComponent { keyboardInput(event) { if (event.keyCode == 65 && e

[Angular] HostListener Method Arguments - Blocking Default Keyboard Behavior

We are going to see how to using method arguments for @HostListener. First, we can use HostListener without method arguments: @HostListener('dblclick') toggle(){ this.collapsed = !this.collapsed; } It works fine. But if we need to get the $event obje

转发: Angular装饰器

Angular中的装饰器是一个函数,它将元数据添加到类.类成员(属性.方法)和函数参数. 用法:要想应用装饰器,把它放在被装饰对象的上面或左边. Angular使用自己的一套装饰器来实现应用程序各部件之间的相互操作. 这个地方是前面几个模块(Modules), 指令(Diretives).组件(Components).依赖注入(Dependency Injection)等从装饰器这个侧面的整理. 你需要做的: 1.搞清楚理解TypeScript的装饰器原理. 2.搞清楚这里面每一个装饰器的作用,

Angular中的装饰器

Angualr中的装饰器是一个函数,它将元数据添加到类.类成员(属性.方法)和函数参数 用法:要想用装饰器,把它放到被装饰对象的上面或做左面 1.类装饰器: 类装饰器应用于类构造函数,可以用来监控.修改或替换类定义 类装饰器表达式会在运行时当作函数被调用,类的构造函数作为唯一的参数 @Component 标记类作为组件并收集组件配置元数据(继承Directive) @Directive 标记类作为指令并收集组件配置元数据 声明当前类时一个指令,并提供关于该指令的元数据 @Pipc 声明当前类是一

Angular 2 属性指令 vs 结构指令

Angular 2 的指令有以下三种: 组件(Component directive):用于构建UI组件,继承于 Directive 类 属性指令(Attribute directive):  用于改变组件的外观或行为 结构指令(Structural directive):  用于动态添加或删除DOM元素来改变DOM布局 组件 import { Component } from '@angular/core'; @Component({       selector: 'my-app', // 

Angular 2.0 从0到1 (七)

第一节:Angular 2.0 从0到1 (一)第二节:Angular 2.0 从0到1 (二)第三节:Angular 2.0 从0到1 (三)第四节:Angular 2.0 从0到1 (四)第五节:Angular 2.0 从0到1 (五)第六节:Angular 2.0 从0到1 (六)第七节:Angular 2.0 从0到1 (七)第八节:Angular 2.0 从0到1 (八)番外:Angular 2.0 从0到1 Rx-隐藏在Angular 2.x中利剑番外:Angular 2.0 从0到