Angular2 源码解读 - 自定义指令@Directive

定义

属性型指令用于改变一个DOM元素的外观或行为

案例

@Directive({
  selector : '[highlight]'
})
export class HighlightDirective{
  constructor(
    renderer : Renderer,
    el : ElementRef
  ){
    renderer.setElementStyle(el.nativeElement, 'backgroundColor', 'gold');
    console.log(
      `* AppRoot highlight called for ${el.nativeElement.tagName}`);
  }
}

详解

1. 使用@Directive注解

@Directive({
  selector : '[highlight]'
})

它至少需要一个selector属性用以标志指令的选择对象,selector属性可以有以下几种写法:

写法 选择对象
element-name 按元素名称选择
class 按类名称选择
[attribute] 按属性名称选择
[attribute] 按属性名称和值选择
:not(sub_selector) 只有当元素与sub_selector不匹配时才选择
selector1,selector2 选择selector1或selector2

这里highlight添加方括号很明显是按属性名称选择。

除此之外Directive指令还经常使用一个host属性。

host : 监听事件或改变行为,为一个key和value都为string类型的对象集

例子

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

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

@Component({
    selector: 'app',
    template: `<button counting>Increment</button>`
})
class App {}

监听事件时,事件名使用()包裹,执行方法处于指令内部类中,并加()以标识运行,可以传递$event相关的属性,但方法执行完成返回false时,该事件将被停止冒泡。

除了监听事件,还可以改变指令的其它属性,例如添加class,例:

host : {
    '[class.bg-red]' : 'true',
    '[class.color-black]' : 'colorBlack'
}

那么上面,首先bg-red类值为true,它会被添加到指令所在的选择器上,而color-black则绑定了一个值,这个值同样在指令内部类中定义,可以使用简单的

colorBlack = false;

color-black类不被添加,也可以使用getter方式:

get colorBlack {
    return false;
}

达到同样的目的。如果没有定义,默认为false

当然,使用host直接定义属性也是可以的

host : {
    'myAttribute' : 'cmx'
}

如果综合使用,假如想让一个DOM点击之后,添加点击过的类样式,可以这样:

host : {
    [class.isClicked] : 'isClicked',
    '(click)' : 'clickIt()'
}

...

{
    isClicked : boolean = false;
    
    clickIt(){
        this.isClicked = true;
    }
}

2. 注入DOM操作相关依赖

正如案例所示,指令的构造函数注入了两个对象,RendererElementRef

Renderer是angular提供的渲染相关api集:

export declare abstract class Renderer {
    abstract selectRootElement(selectorOrNode: string | any, debugInfo?: RenderDebugInfo): any;
    abstract createElement(parentElement: any, name: string, debugInfo?: RenderDebugInfo): any;
    abstract createViewRoot(hostElement: any): any;
    abstract createTemplateAnchor(parentElement: any, debugInfo?: RenderDebugInfo): any;
    abstract createText(parentElement: any, value: string, debugInfo?: RenderDebugInfo): any;
    abstract projectNodes(parentElement: any, nodes: any[]): void;
    abstract attachViewAfter(node: any, viewRootNodes: any[]): void;
    abstract detachView(viewRootNodes: any[]): void;
    abstract destroyView(hostElement: any, viewAllNodes: any[]): void;
    abstract listen(renderElement: any, name: string, callback: Function): Function;
    abstract listenGlobal(target: string, name: string, callback: Function): Function;
    abstract setElementProperty(renderElement: any, propertyName: string, propertyValue: any): void;
    abstract setElementAttribute(renderElement: any, attributeName: string, attributeValue: string): void;
    /**
     * Used only in debug mode to serialize property changes to dom nodes as attributes.
     */
    abstract setBindingDebugInfo(renderElement: any, propertyName: string, propertyValue: string): void;
    abstract setElementClass(renderElement: any, className: string, isAdd: boolean): void;
    abstract setElementStyle(renderElement: any, styleName: string, styleValue: string): void;
    abstract invokeElementMethod(renderElement: any, methodName: string, args?: any[]): void;
    abstract setText(renderNode: any, text: string): void;
    abstract animate(element: any, startingStyles: AnimationStyles, keyframes: AnimationKeyframe[], duration: number, delay: number, easing: string, previousPlayers?: AnimationPlayer[]): AnimationPlayer;
}

api命名清晰明了不过多赘述(感受一下一个好的命名习惯多么关键)

ElementRef是一个视图中原生元素的封装,它在浏览器中通常是DOM元素。

它仅有一个nativeElement属性指向这个原生对象。

防爬 :原文来自[简书 - 沐心chen]

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,165评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,720评论 1 298
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,849评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,245评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,596评论 3 288
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,747评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,977评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,708评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,448评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,657评论 2 249
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,141评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,493评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,153评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,108评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,890评论 0 198
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,799评论 2 277
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,685评论 2 272

推荐阅读更多精彩内容