Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit da072d4

Browse files
mrcolesIgorMinar
authored andcommitted
docs($event): clarify $event is jQuery.Event
The docs should state that an `$event` object is an instance of a jQuery.Event object. Whenever objects are passed around in a framework it's really helpful for the docs to state what’s inside the objects and how to expect them to be populated/work. I had to mess around in my console and with code to figure out what the `$event` object was. Closes #9102
1 parent 4568bc0 commit da072d4

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/content/guide/expression.ngdoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,9 @@ expression, delegate to a JavaScript method instead.
167167
## `$event`
168168

169169
Directives like {@link ng.directive:ngClick `ngClick`} and {@link ng.directive:ngFocus `ngFocus`}
170-
expose a `$event` object within the scope of that expression.
170+
expose a `$event` object within the scope of that expression. The object is an instance of a [jQuery
171+
Event Object](http://api.jquery.com/category/events/event-object/) when jQuery is present or a
172+
similar jqLite object.
171173

172174
<example module="eventExampleApp">
173175
<file name="index.html">

0 commit comments

Comments
 (0)