Repository navigation
Expand file tree
/
Copy pathcomponent.ts
More file actions
234 lines (228 loc) · 8.28 KB
/
Copy pathcomponent.ts
File metadata and controls
234 lines (228 loc) · 8.28 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
/**
* @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 {Injector} from '../di/injector';
import {EnvironmentInjector, getNullInjector} from '../di/r3_injector';
import {Type} from '../interface/type';
import {ComponentRef} from '../linker/component_factory';
import {ComponentFactory} from './component_ref';
import {getComponentDef} from './def_getters';
import {Binding, DirectiveWithBindings} from './dynamic_bindings';
import {assertComponentDef} from './errors';
import {ON_ERROR} from './interfaces/view';
import {ErrorDetails} from '../error_handler';
import {ViewRef as R3ViewRef} from './view_ref';
/**
* Creates a `ComponentRef` instance based on provided component type and a set of options.
*
* @usageNotes
*
* The example below demonstrates how the `createComponent` function can be used
* to create an instance of a ComponentRef dynamically and attach it to an ApplicationRef,
* so that it gets included into change detection cycles.
*
* Note: the example uses standalone components, but the function can also be used for
* non-standalone components (declared in an NgModule) as well.
*
* ```angular-ts
* @Component({
* template: `Hello {{ name }}!`
* })
* class HelloComponent {
* name = 'Angular';
* }
*
* @Component({
* template: `<div id="hello-component-host"></div>`
* })
* class RootComponent {}
*
* // Bootstrap an application.
* const applicationRef = await bootstrapApplication(RootComponent);
*
* // Locate a DOM node that would be used as a host.
* const hostElement = document.getElementById('hello-component-host');
*
* // Get an `EnvironmentInjector` instance from the `ApplicationRef`.
* const environmentInjector = applicationRef.injector;
*
* // We can now create a `ComponentRef` instance.
* const componentRef = createComponent(HelloComponent, {hostElement, environmentInjector});
*
* // Last step is to register the newly created ref using the `ApplicationRef` instance
* // to include the component view into change detection cycles.
* applicationRef.attachView(componentRef.hostView);
* componentRef.changeDetectorRef.detectChanges();
* ```
*
* @param component Component class reference.
* @param options Set of options to use:
* * `environmentInjector`: An `EnvironmentInjector` instance to be used for the component.
* * `hostElement` (optional): A DOM node that should act as a host node for the component. If not
* provided, Angular creates one based on the tag name used in the component selector (and falls
* back to using `div` if selector doesn't have tag name info).
* * `elementInjector` (optional): An `ElementInjector` instance, see additional info about it
* [here](guide/di/hierarchical-dependency-injection#elementinjector).
* * `projectableNodes` (optional): A list of DOM nodes that should be projected through
* [`<ng-content>`](api/core/ng-content) of the new component instance, e.g.,
* `[[element1, element2]]`: projects `element1` and `element2` into the same `<ng-content>`.
* `[[element1, element2], [element3]]`: projects `element1` and `element2` into one `<ng-content>`,
* and `element3` into a separate `<ng-content>`.
* * `directives` (optional): Directives that should be applied to the component.
* * `bindings` (optional): Bindings to apply to the root component.
* * `onError` (optional): A callback that will be invoked when an error occurs during the component's change detection or lifecycle hooks.
* Note that this will not catch errors thrown during the component's construction.
* @returns ComponentRef instance that represents a given Component.
*
* @see [Host view using `ViewContainerRef.createComponent`](guide/components/programmatic-rendering#host-view-using-viewcontainerrefcreatecomponent)
* @see [Popup attached to `document.body` with `createComponent` + `hostElement`](guide/components/programmatic-rendering#popup-attached-to-documentbody-with-createcomponent--hostelement)
*
* @publicApi
*/
export function createComponent<C>(
component: Type<C>,
options: {
environmentInjector: EnvironmentInjector;
hostElement?: Element;
elementInjector?: Injector;
projectableNodes?: Node[][];
directives?: (Type<unknown> | DirectiveWithBindings<unknown>)[];
bindings?: Binding[];
onError?: (error: Error, details: ErrorDetails) => void;
},
): ComponentRef<C> {
ngDevMode && assertComponentDef(component);
const componentDef = getComponentDef(component)!;
const elementInjector = options.elementInjector || getNullInjector();
const factory = new ComponentFactory<C>(componentDef);
const componentRef = factory.create(
elementInjector,
options.projectableNodes,
options.hostElement,
options.environmentInjector,
options.directives,
options.bindings,
);
if (options.onError) {
(componentRef.hostView as R3ViewRef<any>)._lView![ON_ERROR] = options.onError;
}
return componentRef;
}
/**
* An interface that describes the subset of component metadata
* that can be retrieved using the `reflectComponentType` function.
*
* @publicApi
*/
export interface ComponentMirror<C> {
/**
* The component's HTML selector.
*/
get selector(): string;
/**
* The type of component the factory will create.
*/
get type(): Type<C>;
/**
* The inputs of the component.
*/
get inputs(): ReadonlyArray<{
readonly propName: string;
readonly templateName: string;
readonly transform?: (value: any) => any;
readonly isSignal: boolean;
}>;
/**
* The outputs of the component.
*/
get outputs(): ReadonlyArray<{readonly propName: string; readonly templateName: string}>;
/**
* Selector for all <ng-content> elements in the component.
*/
get ngContentSelectors(): ReadonlyArray<string>;
/**
* Whether this component is marked as standalone.
* Note: an extra flag, not present in `ComponentFactory`.
*/
get isStandalone(): boolean;
/**
* // TODO(signals): Remove internal and add public documentation
* @internal
*/
get isSignal(): boolean;
}
/**
* Creates an object that allows to retrieve component metadata.
*
* @usageNotes
*
* The example below demonstrates how to use the function and how the fields
* of the returned object map to the component metadata.
*
* ```angular-ts
* @Component({
* selector: 'foo-component',
* template: `
* <ng-content></ng-content>
* <ng-content select="content-selector-a"></ng-content>
* `,
* })
* class FooComponent {
* @Input('inputName') inputPropName: string;
* @Output('outputName') outputPropName = new EventEmitter<void>();
* }
*
* const mirror = reflectComponentType(FooComponent);
* expect(mirror.type).toBe(FooComponent);
* expect(mirror.selector).toBe('foo-component');
* expect(mirror.isStandalone).toBe(true);
* expect(mirror.inputs).toEqual([{propName: 'inputName', templateName: 'inputPropName'}]);
* expect(mirror.outputs).toEqual([{propName: 'outputName', templateName: 'outputPropName'}]);
* expect(mirror.ngContentSelectors).toEqual([
* '*', // first `<ng-content>` in a template, the selector defaults to `*`
* 'content-selector-a' // second `<ng-content>` in a template
* ]);
* ```
*
* @param component Component class reference.
* @returns An object that allows to retrieve component metadata.
*
* @publicApi
*/
export function reflectComponentType<C>(component: Type<C>): ComponentMirror<C> | null {
const componentDef = getComponentDef(component);
if (!componentDef) return null;
const factory = new ComponentFactory<C>(componentDef);
return {
get selector(): string {
return factory.selector;
},
get type(): Type<C> {
return factory.componentType;
},
get inputs(): ReadonlyArray<{
propName: string;
templateName: string;
transform?: (value: any) => any;
isSignal: boolean;
}> {
return factory.inputs;
},
get outputs(): ReadonlyArray<{propName: string; templateName: string}> {
return factory.outputs;
},
get ngContentSelectors(): ReadonlyArray<string> {
return factory.ngContentSelectors;
},
get isStandalone(): boolean {
return componentDef.standalone;
},
get isSignal(): boolean {
return componentDef.signals;
},
};
}