Skip to content

Commit 8fdd8fd

Browse files
JamesWatlingjamesdaily
authored andcommitted
docs(ngEventDirs): adding quick examples for new events
Closes angular#5338
1 parent 92231e6 commit 8fdd8fd

File tree

1 file changed

+92
-13
lines changed

1 file changed

+92
-13
lines changed

src/ng/directive/ngEventDirs.js

+92-13
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,14 @@ forEach(
6969
* a dblclick. (The Event object is available as `$event`)
7070
*
7171
* @example
72-
* See {@link ng.directive:ngClick ngClick}
72+
<doc:example>
73+
<doc:source>
74+
<button ng-dblclick="count = count + 1" ng-init="count=0">
75+
Increment (on double click)
76+
</button>
77+
count: {{count}}
78+
</doc:source>
79+
</doc:example>
7380
*/
7481

7582

@@ -85,7 +92,14 @@ forEach(
8592
* mousedown. (Event object is available as `$event`)
8693
*
8794
* @example
88-
* See {@link ng.directive:ngClick ngClick}
95+
<doc:example>
96+
<doc:source>
97+
<button ng-mousedown="count = count + 1" ng-init="count=0">
98+
Increment (on mouse down)
99+
</button>
100+
count: {{count}}
101+
</doc:source>
102+
</doc:example>
89103
*/
90104

91105

@@ -101,7 +115,14 @@ forEach(
101115
* mouseup. (Event object is available as `$event`)
102116
*
103117
* @example
104-
* See {@link ng.directive:ngClick ngClick}
118+
<doc:example>
119+
<doc:source>
120+
<button ng-mouseup="count = count + 1" ng-init="count=0">
121+
Increment (on mouse up)
122+
</button>
123+
count: {{count}}
124+
</doc:source>
125+
</doc:example>
105126
*/
106127

107128
/**
@@ -116,7 +137,14 @@ forEach(
116137
* mouseover. (Event object is available as `$event`)
117138
*
118139
* @example
119-
* See {@link ng.directive:ngClick ngClick}
140+
<doc:example>
141+
<doc:source>
142+
<button ng-mouseover="count = count + 1" ng-init="count=0">
143+
Increment (when mouse is over)
144+
</button>
145+
count: {{count}}
146+
</doc:source>
147+
</doc:example>
120148
*/
121149

122150

@@ -132,7 +160,14 @@ forEach(
132160
* mouseenter. (Event object is available as `$event`)
133161
*
134162
* @example
135-
* See {@link ng.directive:ngClick ngClick}
163+
<doc:example>
164+
<doc:source>
165+
<button ng-mouseenter="count = count + 1" ng-init="count=0">
166+
Increment (when mouse enters)
167+
</button>
168+
count: {{count}}
169+
</doc:source>
170+
</doc:example>
136171
*/
137172

138173

@@ -148,7 +183,14 @@ forEach(
148183
* mouseleave. (Event object is available as `$event`)
149184
*
150185
* @example
151-
* See {@link ng.directive:ngClick ngClick}
186+
<doc:example>
187+
<doc:source>
188+
<button ng-mouseleave="count = count + 1" ng-init="count=0">
189+
Increment (when mouse leaves)
190+
</button>
191+
count: {{count}}
192+
</doc:source>
193+
</doc:example>
152194
*/
153195

154196

@@ -164,7 +206,14 @@ forEach(
164206
* mousemove. (Event object is available as `$event`)
165207
*
166208
* @example
167-
* See {@link ng.directive:ngClick ngClick}
209+
<doc:example>
210+
<doc:source>
211+
<button ng-mousemove="count = count + 1" ng-init="count=0">
212+
Increment (when mouse moves)
213+
</button>
214+
count: {{count}}
215+
</doc:source>
216+
</doc:example>
168217
*/
169218

170219

@@ -180,7 +229,12 @@ forEach(
180229
* keydown. (Event object is available as `$event` and can be interrogated for keyCode, altKey, etc.)
181230
*
182231
* @example
183-
* See {@link ng.directive:ngClick ngClick}
232+
<doc:example>
233+
<doc:source>
234+
<input ng-keydown="count = count + 1" ng-init="count=0">
235+
key down count: {{count}}
236+
</doc:source>
237+
</doc:example>
184238
*/
185239

186240

@@ -196,7 +250,12 @@ forEach(
196250
* keyup. (Event object is available as `$event` and can be interrogated for keyCode, altKey, etc.)
197251
*
198252
* @example
199-
* See {@link ng.directive:ngClick ngClick}
253+
<doc:example>
254+
<doc:source>
255+
<input ng-keyup="count = count + 1" ng-init="count=0">
256+
key up count: {{count}}
257+
</doc:source>
258+
</doc:example>
200259
*/
201260

202261

@@ -212,7 +271,12 @@ forEach(
212271
* keypress. (Event object is available as `$event` and can be interrogated for keyCode, altKey, etc.)
213272
*
214273
* @example
215-
* See {@link ng.directive:ngClick ngClick}
274+
<doc:example>
275+
<doc:source>
276+
<input ng-keypress="count = count + 1" ng-init="count=0">
277+
key press count: {{count}}
278+
</doc:source>
279+
</doc:example>
216280
*/
217281

218282

@@ -311,7 +375,12 @@ forEach(
311375
* copy. (Event object is available as `$event`)
312376
*
313377
* @example
314-
* See {@link ng.directive:ngClick ngClick}
378+
<doc:example>
379+
<doc:source>
380+
<input ng-copy="copied=true" ng-init="copied=false; value='copy me'" ng-model="value">
381+
copied: {{copied}}
382+
</doc:source>
383+
</doc:example>
315384
*/
316385

317386
/**
@@ -326,7 +395,12 @@ forEach(
326395
* cut. (Event object is available as `$event`)
327396
*
328397
* @example
329-
* See {@link ng.directive:ngClick ngClick}
398+
<doc:example>
399+
<doc:source>
400+
<input ng-cut="cut=true" ng-init="cut=false; value='cut me'" ng-model="value">
401+
cut: {{cut}}
402+
</doc:source>
403+
</doc:example>
330404
*/
331405

332406
/**
@@ -341,5 +415,10 @@ forEach(
341415
* paste. (Event object is available as `$event`)
342416
*
343417
* @example
344-
* See {@link ng.directive:ngClick ngClick}
418+
<doc:example>
419+
<doc:source>
420+
<input ng-paste="paste=true" ng-init="paste=false" placeholder='paste here'>
421+
pasted: {{paste}}
422+
</doc:source>
423+
</doc:example>
345424
*/

0 commit comments

Comments
 (0)