Какой тип Typescript является событием Angular2

89

Если у меня есть следующая кнопка в html файле

<button (click)="doSomething('testing', $event)">Do something</button>

Также в соответствующем компоненте у меня есть эта функция

doSomething(testString: string, event){
    event.stopPropagation();
    console.log(testString + ': I am doing something');
}

Есть ли правильный тип, который следует назначить $eventвходу? Параметр события сам по себе является объектом, НО если я назначу его объекту типа, я получаю сообщение об ошибке

Свойство stopPropogation не существует для объекта типа

Итак, что Typescript считает $eventвводом?

Алекс Дж
источник
5
doSomething(testString: string, event: MouseEvent)
Эрик Мартинес,
1
Эрик Мартинес: Вы можете опубликовать свой комментарий в качестве ответа? Это убрало все полученные мною флаги, поэтому я считаю это правильным.
Alex J

Ответы:

74

По предложению @AlexJ

Событие, через которое вы прошли, $eventявляется событием DOM, поэтому вы можете использовать в EventNameкачестве типа.

В вашем случае это событие MouseEvent, и в документах говорится, цитируя

Интерфейс MouseEvent представляет события, которые происходят из-за взаимодействия пользователя с указывающим устройством (например, мышью). Общие события, использующие этот интерфейс, включают щелчок, dblclick, mouseup, mousedown .

Во всех этих случаях вы получите файл MouseEvent.

Другой пример: если у вас есть этот код

<input type="text" (blur)="event($event)"

Когда событие сработает, вы получите файл FocusEvent.

Таким образом, вы можете сделать это очень просто, запишите событие в консоль, и вы увидите сообщение, подобное этому, в котором мы будем иметь имя события

FocusEvent {isTrusted: true, relatedTarget: null, view: Window, detail: 0, which: 0…}

Вы всегда можете посетить документацию, чтобы просмотреть список существующих событий .

редактировать

Вы также можете проверить TypeScript dom.generated.d.tsсо всеми перенесенными типами. В вашем случае stopPropagation()это часть Event, расширенная пользователем MouseEvent.

Эрик Мартинес
источник
См. Этот ответ для типа HTMLInputEvent.
hlovdal
1
Следует отметить, что если событие исходит от компонента Angular через @Output, как правило, поле компонента типа EventEmitter<T>, то тип $eventаргумента равен T. См. Angular.io/api/core/EventEmitter .
jfroy 03
26

Некоторые часто используемые события и связанные с ними имена ( MouseEvent , FocusEvent , TouchEvent , DragEvent , KeyboardEvent ):

| MouseEvent | FocusEvent |  TouchEvent | DragEvent | KeyboardEvent |
|:----------:|:----------:|:-----------:|:---------:|:-------------:|
|    click   |    focus   |  touchstart |    drag   |    keypress   |
|   mouseup  |    blur    |  touchmove  |    drop   |     keyup     |
| mouseleave |   focusin  | touchcancel |  dragend  |    keydown    |
|  mouseover |  focusout  |   touchend  |  dragover |               |

Общее событие связано с:

  • близко
  • изменение
  • инвалид
  • играть
  • сброс настроек
  • прокрутка
  • Выбрать
  • представить
  • переключить
  • ожидание

Если вы покопаетесь в репозитории Typescript , dom.generated.d.ts предоставляет интерфейс глобальных событий (кредит принадлежит ответу Эрика ), где вы можете найти все сопоставления обработчиков событий в строке 5725 :

interface GlobalEventHandlersEventMap {
  "abort": UIEvent;
  "animationcancel": AnimationEvent;
  "animationend": AnimationEvent;
  "animationiteration": AnimationEvent;
  "animationstart": AnimationEvent;
  "auxclick": MouseEvent;
  "blur": FocusEvent;
  "cancel": Event;
  "canplay": Event;
  "canplaythrough": Event;
  "change": Event;
  "click": MouseEvent;
  "close": Event;
  "contextmenu": MouseEvent;
  "cuechange": Event;
  "dblclick": MouseEvent;
  "drag": DragEvent;
  "dragend": DragEvent;
  "dragenter": DragEvent;
  "dragexit": Event;
  "dragleave": DragEvent;
  "dragover": DragEvent;
  "dragstart": DragEvent;
  "drop": DragEvent;
  "durationchange": Event;
  "emptied": Event;
  "ended": Event;
  "error": ErrorEvent;
  "focus": FocusEvent;
  "focusin": FocusEvent;
  "focusout": FocusEvent;
  "gotpointercapture": PointerEvent;
  "input": Event;
  "invalid": Event;
  "keydown": KeyboardEvent;
  "keypress": KeyboardEvent;
  "keyup": KeyboardEvent;
  "load": Event;
  "loadeddata": Event;
  "loadedmetadata": Event;
  "loadend": ProgressEvent;
  "loadstart": Event;
  "lostpointercapture": PointerEvent;
  "mousedown": MouseEvent;
  "mouseenter": MouseEvent;
  "mouseleave": MouseEvent;
  "mousemove": MouseEvent;
  "mouseout": MouseEvent;
  "mouseover": MouseEvent;
  "mouseup": MouseEvent;
  "pause": Event;
  "play": Event;
  "playing": Event;
  "pointercancel": PointerEvent;
  "pointerdown": PointerEvent;
  "pointerenter": PointerEvent;
  "pointerleave": PointerEvent;
  "pointermove": PointerEvent;
  "pointerout": PointerEvent;
  "pointerover": PointerEvent;
  "pointerup": PointerEvent;
  "progress": ProgressEvent;
  "ratechange": Event;
  "reset": Event;
  "resize": UIEvent;
  "scroll": Event;
  "securitypolicyviolation": SecurityPolicyViolationEvent;
  "seeked": Event;
  "seeking": Event;
  "select": Event;
  "selectionchange": Event;
  "selectstart": Event;
  "stalled": Event;
  "submit": Event;
  "suspend": Event;
  "timeupdate": Event;
  "toggle": Event;
  "touchcancel": TouchEvent;
  "touchend": TouchEvent;
  "touchmove": TouchEvent;
  "touchstart": TouchEvent;
  "transitioncancel": TransitionEvent;
  "transitionend": TransitionEvent;
  "transitionrun": TransitionEvent;
  "transitionstart": TransitionEvent;
  "volumechange": Event;
  "waiting": Event;
  "wheel": WheelEvent;
}
CPHPython
источник
3

Согласно официальному eventпредставителю, тип Object, также в моем случае, когда я eventпривожу тип к объекту, он не выдает никаких ошибок, но после прочтения документации angular2 найден eventтип, EventEmitterпоэтому вы можете ввести свое событие вEventEmitter

см. здесь plunkr для того же http://plnkr.co/edit/8HRA3bM0NxXrzBAjWYXc?p=preview

для получения дополнительной информации см. здесь https://angular.io/docs/ts/latest/guide/template-syntax.html#!#event-binding

Пардип Джайн
источник