-
Notifications
You must be signed in to change notification settings - Fork 27.2k
Expand file tree
/
Copy pathdi.ts
More file actions
504 lines (485 loc) Β· 16.6 KB
/
di.ts
File metadata and controls
504 lines (485 loc) Β· 16.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.dev/license
*/
import {ProviderToken} from '../di/provider_token';
import {makePropDecorator} from '../util/decorators';
/**
* Type of the `Attribute` decorator / constructor function.
*
* @publicApi
*/
export interface AttributeDecorator {
/**
* Specifies that a constant attribute value should be injected.
*
* The directive can inject constant string literals of host element attributes.
*
* @usageNotes
*
* Suppose we have an `<input>` element and want to know its `type`.
*
* ```html
* <input type="text">
* ```
*
* A decorator can inject string literal `text` as in the following example.
*
* {@example core/ts/metadata/metadata.ts region='attributeMetadata'}
*
* @publicApi
*/
(name: string): any;
new (name: string): Attribute;
}
/**
* Type of the Attribute metadata.
*
* @publicApi
*/
export interface Attribute {
/**
* The name of the attribute to be injected into the constructor.
*/
attributeName?: string;
}
/**
* Type of the Query metadata.
*
* @publicApi
*/
export interface Query {
descendants: boolean;
emitDistinctChangesOnly: boolean;
first: boolean;
read: any;
isViewQuery: boolean;
selector: any;
static?: boolean;
/**
* @internal
*
* Whether the query is a signal query.
*
* This option exists for JIT compatibility. Users are not expected to use this.
* Angular needs a way to capture queries from classes so that the internal query
* functions can be generated. This needs to happen before the component is instantiated.
* Due to this, for JIT compilation, signal queries need an additional decorator
* declaring the query. Angular provides a TS transformer to automatically handle this
* for JIT usage (e.g. in tests).
*/
isSignal?: boolean;
}
// Stores the default value of `emitDistinctChangesOnly` when the `emitDistinctChangesOnly` is not
// explicitly set.
export const emitDistinctChangesOnlyDefaultValue = true;
/**
* Base class for query metadata.
*
* @see {@link ContentChildren}
* @see {@link ContentChild}
* @see {@link ViewChildren}
* @see {@link ViewChild}
*
* @publicApi
*/
export abstract class Query {}
/**
* Type of the ContentChildren decorator / constructor function.
*
* @see {@link ContentChildren}
* @publicApi
*/
export interface ContentChildrenDecorator {
/**
* @description
* Property decorator that configures a content query.
*
* Use to get the `QueryList` of elements or directives from the content DOM.
* Any time a child element is added, removed, or moved, the query list will be
* updated, and the changes observable of the query list will emit a new value.
*
* Content queries are set before the `ngAfterContentInit` callback is called.
*
* Does not retrieve elements or directives that are in other components' templates,
* since a component's template is always a black box to its ancestors.
*
* **Metadata Properties**:
*
* * **selector** - The directive type or the name used for querying.
* * **descendants** - If `true` include all descendants of the element. If `false` then only
* query direct children of the element.
* * **emitDistinctChangesOnly** - The ` QueryList#changes` observable will emit new values only
* if the QueryList result has changed. When `false` the `changes` observable might emit even
* if the QueryList has not changed.
* ** Note: *** This config option is **deprecated**, it will be permanently set to `true` and
* removed in future versions of Angular.
* * **read** - Used to read a different token from the queried elements.
*
* The following selectors are supported.
* * Any class with the `@Component` or `@Directive` decorator
* * A template reference variable as a string (e.g. query `<my-component #cmp></my-component>`
* with `@ContentChildren('cmp')`)
* * Any provider defined in the child component tree of the current component (e.g.
* `@ContentChildren(SomeService) someService: SomeService`)
* * Any provider defined through a string token (e.g. `@ContentChildren('someToken')
* someTokenVal: any`)
* * A `TemplateRef` (e.g. query `<ng-template></ng-template>` with
* `@ContentChildren(TemplateRef) template;`)
*
* In addition, multiple string selectors can be separated with a comma (e.g.
* `@ContentChildren('cmp1,cmp2')`)
*
* The following values are supported by `read`:
* * Any class with the `@Component` or `@Directive` decorator
* * Any provider defined on the injector of the component that is matched by the `selector` of
* this query
* * Any provider defined through a string token (e.g. `{provide: 'token', useValue: 'val'}`)
* * `TemplateRef`, `ElementRef`, and `ViewContainerRef`
*
* @usageNotes
*
* Here is a simple demonstration of how the `ContentChildren` decorator can be used.
*
* {@example core/di/ts/contentChildren/content_children_howto.ts region='HowTo'}
*
* ### Tab-pane example
*
* Here is a slightly more realistic example that shows how `ContentChildren` decorators
* can be used to implement a tab pane component.
*
* {@example core/di/ts/contentChildren/content_children_example.ts region='Component'}
*
* @Annotation
* @see [Content queries](guide/components/queries#decorator-content-queries)
*/
(
selector: ProviderToken<unknown> | Function | string,
opts?: {
descendants?: boolean;
emitDistinctChangesOnly?: boolean;
read?: any;
},
): any;
new (
selector: ProviderToken<unknown> | Function | string,
opts?: {descendants?: boolean; emitDistinctChangesOnly?: boolean; read?: any},
): Query;
}
/**
* Type of the ContentChildren metadata.
*
*
* @Annotation
* @publicApi
*/
export type ContentChildren = Query;
/**
* ContentChildren decorator and metadata.
*
*
* @Annotation
* @publicApi
*/
export const ContentChildren: ContentChildrenDecorator = makePropDecorator(
'ContentChildren',
(selector?: any, opts: any = {}) => ({
selector,
first: false,
isViewQuery: false,
descendants: false,
emitDistinctChangesOnly: emitDistinctChangesOnlyDefaultValue,
...opts,
}),
Query,
);
/**
* Type of the ContentChild decorator / constructor function.
*
* @publicApi
*/
export interface ContentChildDecorator {
/**
* @description
* Property decorator that configures a content query.
*
* Use to get the first element or the directive matching the selector from the content DOM.
* If the content DOM changes, and a new child matches the selector,
* the property will be updated.
*
* Does not retrieve elements or directives that are in other components' templates,
* since a component's template is always a black box to its ancestors.
*
* **Metadata Properties**:
*
* * **selector** - The directive type or the name used for querying.
* * **descendants** - If `true` (default) include all descendants of the element. If `false` then
* only query direct children of the element.
* * **read** - Used to read a different token from the queried element.
* * **static** - True to resolve query results before change detection runs,
* false to resolve after change detection. Defaults to false.
*
* The following selectors are supported.
* * Any class with the `@Component` or `@Directive` decorator
* * A template reference variable as a string (e.g. query `<my-component #cmp></my-component>`
* with `@ContentChild('cmp')`)
* * Any provider defined in the child component tree of the current component (e.g.
* `@ContentChild(SomeService) someService: SomeService`)
* * Any provider defined through a string token (e.g. `@ContentChild('someToken') someTokenVal:
* any`)
* * A `TemplateRef` (e.g. query `<ng-template></ng-template>` with `@ContentChild(TemplateRef)
* template;`)
*
* The following values are supported by `read`:
* * Any class with the `@Component` or `@Directive` decorator
* * Any provider defined on the injector of the component that is matched by the `selector` of
* this query
* * Any provider defined through a string token (e.g. `{provide: 'token', useValue: 'val'}`)
* * `TemplateRef`, `ElementRef`, and `ViewContainerRef`
*
* Difference between dynamic and static queries:
*
* | Queries | Details |
* |:--- |:--- |
* | Dynamic queries \(`static: false`\) | The query resolves before the `ngAfterContentInit()`
* callback is called. The result will be updated for changes to your view, such as changes to
* `ngIf` and `ngFor` blocks. | | Static queries \(`static: true`\) | The query resolves once
* the view has been created, but before change detection runs (before the `ngOnInit()` callback
* is called). The result, though, will never be updated to reflect changes to your view, such as
* changes to `ngIf` and `ngFor` blocks. |
*
* @usageNotes
*
* {@example core/di/ts/contentChild/content_child_howto.ts region='HowTo'}
*
* ### Example
*
* {@example core/di/ts/contentChild/content_child_example.ts region='Component'}
*
* @Annotation
* @see [Content queries](guide/components/queries#decorator-content-queries)
*/
(
selector: ProviderToken<unknown> | Function | string,
opts?: {descendants?: boolean; read?: any; static?: boolean},
): any;
new (
selector: ProviderToken<unknown> | Function | string,
opts?: {descendants?: boolean; read?: any; static?: boolean},
): ContentChild;
}
/**
* Type of the ContentChild metadata.
*
* @publicApi
*/
export type ContentChild = Query;
/**
* ContentChild decorator and metadata.
*
*
* @Annotation
*
* @publicApi
*/
export const ContentChild: ContentChildDecorator = makePropDecorator(
'ContentChild',
(selector?: any, opts: any = {}) => ({
selector,
first: true,
isViewQuery: false,
descendants: true,
...opts,
}),
Query,
);
/**
* Type of the ViewChildren decorator / constructor function.
*
* @see {@link ViewChildren}
*
* @publicApi
*/
export interface ViewChildrenDecorator {
/**
* @description
* Property decorator that configures a view query.
*
* Use to get the `QueryList` of elements or directives from the view DOM.
* Any time a child element is added, removed, or moved, the query list will be updated,
* and the changes observable of the query list will emit a new value.
*
* View queries are set before the `ngAfterViewInit` callback is called.
*
* **Metadata Properties**:
*
* * **selector** - The directive type or the name used for querying.
* * **read** - Used to read a different token from the queried elements.
* * **emitDistinctChangesOnly** - The ` QueryList#changes` observable will emit new values only
* if the QueryList result has changed. When `false` the `changes` observable might emit even
* if the QueryList has not changed.
* ** Note: *** This config option is **deprecated**, it will be permanently set to `true` and
* removed in future versions of Angular.
*
* The following selectors are supported.
* * Any class with the `@Component` or `@Directive` decorator
* * A template reference variable as a string (e.g. query `<my-component #cmp></my-component>`
* with `@ViewChildren('cmp')`)
* * Any provider defined in the child component tree of the current component (e.g.
* `@ViewChildren(SomeService) someService!: SomeService`)
* * Any provider defined through a string token (e.g. `@ViewChildren('someToken')
* someTokenVal!: any`)
* * A `TemplateRef` (e.g. query `<ng-template></ng-template>` with `@ViewChildren(TemplateRef)
* template;`)
*
* In addition, multiple string selectors can be separated with a comma (e.g.
* `@ViewChildren('cmp1,cmp2')`)
*
* The following values are supported by `read`:
* * Any class with the `@Component` or `@Directive` decorator
* * Any provider defined on the injector of the component that is matched by the `selector` of
* this query
* * Any provider defined through a string token (e.g. `{provide: 'token', useValue: 'val'}`)
* * `TemplateRef`, `ElementRef`, and `ViewContainerRef`
*
* @usageNotes
*
* {@example core/di/ts/viewChildren/view_children_howto.ts region='HowTo'}
*
* ### Another example
*
* {@example core/di/ts/viewChildren/view_children_example.ts region='Component'}
*
* @Annotation
* @see [View queries](guide/components/queries#decorator-view-queries)
*/
(
selector: ProviderToken<unknown> | Function | string,
opts?: {read?: any; emitDistinctChangesOnly?: boolean},
): any;
new (
selector: ProviderToken<unknown> | Function | string,
opts?: {read?: any; emitDistinctChangesOnly?: boolean},
): ViewChildren;
}
/**
* Type of the ViewChildren metadata.
*
* @publicApi
*/
export type ViewChildren = Query;
/**
* ViewChildren decorator and metadata.
*
* @Annotation
* @publicApi
*/
export const ViewChildren: ViewChildrenDecorator = makePropDecorator(
'ViewChildren',
(selector?: any, opts: any = {}) => ({
selector,
first: false,
isViewQuery: true,
descendants: true,
emitDistinctChangesOnly: emitDistinctChangesOnlyDefaultValue,
...opts,
}),
Query,
);
/**
* Type of the ViewChild decorator / constructor function.
*
* @see {@link ViewChild}
* @publicApi
*/
export interface ViewChildDecorator {
/**
* @description
* Property decorator that configures a view query.
* The change detector looks for the first element or the directive matching the selector
* in the view DOM. If the view DOM changes, and a new child matches the selector,
* the property is updated.
*
* **Metadata Properties**:
*
* * **selector** - The directive type or the name used for querying.
* * **read** - Used to read a different token from the queried elements.
* * **static** - `true` to resolve query results before change detection runs,
* `false` to resolve after change detection. Defaults to `false`.
*
*
* The following selectors are supported.
* * Any class with the `@Component` or `@Directive` decorator
* * A template reference variable as a string (e.g. query `<my-component #cmp></my-component>`
* with `@ViewChild('cmp')`)
* * Any provider defined in the child component tree of the current component (e.g.
* `@ViewChild(SomeService) someService: SomeService`)
* * Any provider defined through a string token (e.g. `@ViewChild('someToken') someTokenVal:
* any`)
* * A `TemplateRef` (e.g. query `<ng-template></ng-template>` with `@ViewChild(TemplateRef)
* template;`)
*
* The following values are supported by `read`:
* * Any class with the `@Component` or `@Directive` decorator
* * Any provider defined on the injector of the component that is matched by the `selector` of
* this query
* * Any provider defined through a string token (e.g. `{provide: 'token', useValue: 'val'}`)
* * `TemplateRef`, `ElementRef`, and `ViewContainerRef`
*
* Difference between dynamic and static queries:
* * Dynamic queries \(`static: false`\) - The query resolves before the `ngAfterViewInit()`
* callback is called. The result will be updated for changes to your view, such as changes to
* `ngIf` and `ngFor` blocks.
* * Static queries \(`static: true`\) - The query resolves once
* the view has been created, but before change detection runs (before the `ngOnInit()` callback
* is called). The result, though, will never be updated to reflect changes to your view, such as
* changes to `ngIf` and `ngFor` blocks.
*
* @usageNotes
*
* ### Example 1
*
* {@example core/di/ts/viewChild/view_child_example.ts region='Component'}
*
* ### Example 2
*
* {@example core/di/ts/viewChild/view_child_howto.ts region='HowTo'}
*
* @Annotation
* @see [View queries](guide/components/queries#decorator-view-queries)
*/
(
selector: ProviderToken<unknown> | Function | string,
opts?: {read?: any; static?: boolean},
): any;
new (
selector: ProviderToken<unknown> | Function | string,
opts?: {read?: any; static?: boolean},
): ViewChild;
}
/**
* Type of the ViewChild metadata.
*
* @publicApi
*/
export type ViewChild = Query;
/**
* ViewChild decorator and metadata.
*
* @Annotation
* @publicApi
*/
export const ViewChild: ViewChildDecorator = makePropDecorator(
'ViewChild',
(selector: any, opts: any) => ({
selector,
first: true,
isViewQuery: true,
descendants: true,
...opts,
}),
Query,
);