Typescript枚举看起来和Angular2的ngSwitch指令很匹配。但是当我试图在我的组件的模板中使用枚举时,我得到“无法读取属性'xxx'的未定义在…”如何在组件模板中使用枚举值?

请注意,这与如何基于枚举(ngFor)的所有值创建html选择选项不同。这个问题是关于基于枚举的特定值的ngSwitch。尽管出现了创建枚举的类内部引用的相同方法。


当前回答

您可以创建一个自定义装饰器,添加到组件中,使其能够识别枚举。

myenum.enum.ts:

export enum MyEnum {
    FirstValue,
    SecondValue
}

myenumaware.decorator.ts

import { MyEnum } from './myenum.enum';

export function MyEnumAware(constructor: Function) {
    constructor.prototype.MyEnum = MyEnum;
}

enum-aware.component.ts

import { Component } from '@angular2/core';
import { MyEnum } from './myenum.enum';
import { MyEnumAware } from './myenumaware.decorator';

@Component({
  selector: 'enum-aware',
  template: `
    <div [ngSwitch]="myEnumValue">
      <div *ngSwitchCase="MyEnum.FirstValue">
        First Value
      </div>
      <div *ngSwitchCase="MyEnum.SecondValue">
        Second Value
      </div>
    </div>
    <button (click)="toggleValue()">Toggle Value</button>
  `,
})
@MyEnumAware // <---------------!!!
export default class EnumAwareComponent {
  myEnumValue: MyEnum = MyEnum.FirstValue;

  toggleValue() {
    this.myEnumValue = this.myEnumValue === MyEnum.FirstValue
        ? MyEnum.SecondValue : MyEnum.FirstValue;
  }
}

其他回答

首先考虑“我真的想做这件事吗?”

我在HTML中直接引用枚举没有问题,但在某些情况下,有更干净的替代方案,不会失去类型安全性。 例如,如果你选择在我的其他回答中显示的方法,你可能已经在你的组件中声明了TT,就像这样:

public TT = 
{
    // Enum defines (Horizontal | Vertical)
    FeatureBoxResponsiveLayout: FeatureBoxResponsiveLayout   
}

要在HTML中显示不同的布局,你需要为每种布局类型使用*ngIf,并且你可以直接引用组件HTML中的枚举:

*ngIf="(featureBoxResponsiveService.layout | async) == TT.FeatureBoxResponsiveLayout.Horizontal"

这个例子使用一个服务来获取当前布局,通过async管道运行它,然后将它与我们的enum值进行比较。它相当啰嗦,令人费解,看起来也没什么意思。它还公开枚举的名称,该名称本身可能过于详细。

另一种选择是保留HTML的类型安全性

或者你也可以这样做,并在组件的.ts文件中声明一个更可读的函数:

*ngIf="isResponsiveLayout('Horizontal')"

多干净!但如果有人不小心输入了“水平”呢?在HTML中使用枚举的全部原因是为了类型安全,对吧?

我们仍然可以通过keyof和一些typescript魔法来实现这一点。这是函数的定义:

isResponsiveLayout(value: keyof typeof FeatureBoxResponsiveLayout)
{
    return FeatureBoxResponsiveLayout[value] == this.featureBoxResponsiveService.layout.value;
}

注意使用FeatureBoxResponsiveLayout[string]将传入的字符串值转换为enum的数值。

如果使用了无效值,这将给出带有AOT编译的错误消息。

类型为“h4horizontal”的参数不能赋值给类型为“Vertical”的参数|“Horizontal”

目前VSCode还不够智能,不能在HTML编辑器中下划线h4horizont,但是你会在编译时得到警告(使用——prod build或——aot开关)。这也可能在未来的更新中得到改进。

您可以创建一个自定义装饰器,添加到组件中,使其能够识别枚举。

myenum.enum.ts:

export enum MyEnum {
    FirstValue,
    SecondValue
}

myenumaware.decorator.ts

import { MyEnum } from './myenum.enum';

export function MyEnumAware(constructor: Function) {
    constructor.prototype.MyEnum = MyEnum;
}

enum-aware.component.ts

import { Component } from '@angular2/core';
import { MyEnum } from './myenum.enum';
import { MyEnumAware } from './myenumaware.decorator';

@Component({
  selector: 'enum-aware',
  template: `
    <div [ngSwitch]="myEnumValue">
      <div *ngSwitchCase="MyEnum.FirstValue">
        First Value
      </div>
      <div *ngSwitchCase="MyEnum.SecondValue">
        Second Value
      </div>
    </div>
    <button (click)="toggleValue()">Toggle Value</button>
  `,
})
@MyEnumAware // <---------------!!!
export default class EnumAwareComponent {
  myEnumValue: MyEnum = MyEnum.FirstValue;

  toggleValue() {
    this.myEnumValue = this.myEnumValue === MyEnum.FirstValue
        ? MyEnum.SecondValue : MyEnum.FirstValue;
  }
}

你可以在你的组件类中创建一个对枚举的引用(我只是将初始字符改为小写),然后从模板(plunker)中使用该引用:

import {Component} from 'angular2/core';

enum CellType {Text, Placeholder}
class Cell {
  constructor(public text: string, public type: CellType) {}
}
@Component({
  selector: 'my-app',
  template: `
    <div [ngSwitch]="cell.type">
      <div *ngSwitchCase="cellType.Text">
        {{cell.text}}
      </div>
      <div *ngSwitchCase="cellType.Placeholder">
        Placeholder
      </div>
    </div>
    <button (click)="setType(cellType.Text)">Text</button>
    <button (click)="setType(cellType.Placeholder)">Placeholder</button>
  `,
})
export default class AppComponent {

  // Store a reference to the enum
  cellType = CellType;
  public cell: Cell;

  constructor() {
    this.cell = new Cell("Hello", CellType.Text)
  }

  setType(type: CellType) {
    this.cell.type = type;
  }
}

作为@Eric Lease的装饰器(不幸的是,它不能使用——aot(因此也不能使用——prod)构建)的替代方案,我求助于使用一个公开应用程序所有枚举的服务。只需要公开地将它注入到每个需要它的组件中,在一个简单的名称下,之后你可以在视图中访问枚举。例如:

服务

import { Injectable } from '@angular/core';
import { MyEnumType } from './app.enums';

@Injectable()
export class EnumsService {
  MyEnumType = MyEnumType;
  // ...
}

不要忘记将它包含在模块的提供者列表中。

组件类

export class MyComponent {
  constructor(public enums: EnumsService) {}
  @Input() public someProperty: MyEnumType;

  // ...
}

html组件

<div *ngIf="someProperty === enums.MyEnumType.SomeValue">Match!</div>

这很简单,而且很有魅力:) 只是像这样声明你的枚举,你可以在HTML模板上使用它

statusEnum: typeof StatusEnum = StatusEnum;