This commit updates the docs examples to be compatible with the following Angular-specific tslint rules: - `component-selector` - `directive-selector` - `no-conflicting-lifecycle` - `no-host-metadata-property` - `no-input-rename` - `no-output-native` - `no-output-rename` This is in preparation of updating the docs examples `tslint.json` to match the one generated for new Angular CLI apps in a future commit. PR Close #38143
		
			
				
	
	
		
			175 lines
		
	
	
		
			5.5 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			175 lines
		
	
	
		
			5.5 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
# Dynamic component loader
 | 
						|
 | 
						|
Component templates are not always fixed. An application may need to load new components at runtime.
 | 
						|
 | 
						|
This cookbook shows you how to use `ComponentFactoryResolver` to add components dynamically.
 | 
						|
 | 
						|
See the <live-example name="dynamic-component-loader"></live-example>
 | 
						|
of the code in this cookbook.
 | 
						|
 | 
						|
{@a dynamic-loading}
 | 
						|
 | 
						|
## Dynamic component loading
 | 
						|
 | 
						|
The following example shows how to build a dynamic ad banner.
 | 
						|
 | 
						|
The hero agency is planning an ad campaign with several different
 | 
						|
ads cycling through the banner. New ad components are added
 | 
						|
frequently by several different teams. This makes it impractical
 | 
						|
to use a template with a static component structure.
 | 
						|
 | 
						|
Instead, you need a way to load a new component without a fixed
 | 
						|
reference to the component in the ad banner's template.
 | 
						|
 | 
						|
Angular comes with its own API for loading components dynamically.
 | 
						|
 | 
						|
 | 
						|
{@a directive}
 | 
						|
 | 
						|
## The anchor directive
 | 
						|
 | 
						|
Before you can add components you have to define an anchor point
 | 
						|
to tell Angular where to insert components.
 | 
						|
 | 
						|
The ad banner uses a helper directive called `AdDirective` to
 | 
						|
mark valid insertion points in the template.
 | 
						|
 | 
						|
 | 
						|
<code-example path="dynamic-component-loader/src/app/ad.directive.ts" header="src/app/ad.directive.ts"></code-example>
 | 
						|
 | 
						|
 | 
						|
 | 
						|
`AdDirective` injects `ViewContainerRef` to gain access to the view
 | 
						|
container of the element that will host the dynamically added component.
 | 
						|
 | 
						|
In the `@Directive` decorator, notice the selector name, `adHost`;
 | 
						|
that's what you use to apply the directive to the element.
 | 
						|
The next section shows you how.
 | 
						|
 | 
						|
{@a loading-components}
 | 
						|
 | 
						|
## Loading components
 | 
						|
 | 
						|
Most of the ad banner implementation is in `ad-banner.component.ts`.
 | 
						|
To keep things simple in this example, the HTML is in the `@Component`
 | 
						|
decorator's `template` property as a template string.
 | 
						|
 | 
						|
The `<ng-template>` element is where you apply the directive you just made.
 | 
						|
To apply the `AdDirective`, recall the selector from `ad.directive.ts`,
 | 
						|
`[adHost]`. Apply that to `<ng-template>` without the square brackets. Now Angular knows
 | 
						|
where to dynamically load components.
 | 
						|
 | 
						|
 | 
						|
<code-example path="dynamic-component-loader/src/app/ad-banner.component.ts" region="ad-host" header="src/app/ad-banner.component.ts (template)"></code-example>
 | 
						|
 | 
						|
 | 
						|
 | 
						|
The `<ng-template>` element is a good choice for dynamic components
 | 
						|
because it doesn't render any additional output.
 | 
						|
 | 
						|
 | 
						|
{@a resolving-components}
 | 
						|
 | 
						|
 | 
						|
## Resolving components
 | 
						|
 | 
						|
Take a closer look at the methods in `ad-banner.component.ts`.
 | 
						|
 | 
						|
`AdBannerComponent` takes an array of `AdItem` objects as input,
 | 
						|
which ultimately comes from `AdService`.  `AdItem` objects specify
 | 
						|
the type of component to load and any data to bind to the
 | 
						|
component.`AdService` returns the actual ads making up the ad campaign.
 | 
						|
 | 
						|
Passing an array of components to `AdBannerComponent` allows for a
 | 
						|
dynamic list of ads without static elements in the template.
 | 
						|
 | 
						|
With its `getAds()` method, `AdBannerComponent` cycles through the array of `AdItems`
 | 
						|
and loads a new component every 3 seconds by calling `loadComponent()`.
 | 
						|
 | 
						|
 | 
						|
<code-example path="dynamic-component-loader/src/app/ad-banner.component.ts" region="class" header="src/app/ad-banner.component.ts (excerpt)"></code-example>
 | 
						|
 | 
						|
 | 
						|
 | 
						|
The `loadComponent()` method is doing a lot of the heavy lifting here.
 | 
						|
Take it step by step. First, it picks an ad.
 | 
						|
 | 
						|
 | 
						|
<div class="alert is-helpful">
 | 
						|
 | 
						|
 | 
						|
 | 
						|
**How _loadComponent()_ chooses an ad**
 | 
						|
 | 
						|
The `loadComponent()` method chooses an ad using some math.
 | 
						|
 | 
						|
First, it sets the `currentAdIndex` by taking whatever it
 | 
						|
currently is plus one, dividing that by the length of the `AdItem` array, and
 | 
						|
using the _remainder_ as the new `currentAdIndex` value. Then, it uses that
 | 
						|
value to select an `adItem` from the array.
 | 
						|
 | 
						|
 | 
						|
</div>
 | 
						|
 | 
						|
 | 
						|
 | 
						|
After `loadComponent()` selects an ad, it uses `ComponentFactoryResolver`
 | 
						|
to resolve a `ComponentFactory` for each specific component.
 | 
						|
The `ComponentFactory` then creates an instance of each component.
 | 
						|
 | 
						|
Next, you're targeting the `viewContainerRef` that
 | 
						|
exists on this specific instance of the component. How do you know it's
 | 
						|
this specific instance? Because it's referring to `adHost` and `adHost` is the
 | 
						|
directive you set up earlier to tell Angular where to insert dynamic components.
 | 
						|
 | 
						|
As you may recall, `AdDirective` injects `ViewContainerRef` into its constructor.
 | 
						|
This is how the directive accesses the element that you want to use to host the dynamic component.
 | 
						|
 | 
						|
To add the component to the template, you call `createComponent()` on `ViewContainerRef`.
 | 
						|
 | 
						|
The `createComponent()` method returns a reference to the loaded component.
 | 
						|
Use that reference to interact with the component by assigning to its properties or calling its methods.
 | 
						|
 | 
						|
 | 
						|
 | 
						|
{@a common-interface}
 | 
						|
 | 
						|
 | 
						|
## The _AdComponent_ interface
 | 
						|
 | 
						|
In the ad banner, all components implement a common `AdComponent` interface to
 | 
						|
standardize the API for passing data to the components.
 | 
						|
 | 
						|
Here are two sample components and the `AdComponent` interface for reference:
 | 
						|
 | 
						|
 | 
						|
<code-tabs>
 | 
						|
 | 
						|
  <code-pane header="hero-job-ad.component.ts" path="dynamic-component-loader/src/app/hero-job-ad.component.ts">
 | 
						|
 | 
						|
  </code-pane>
 | 
						|
 | 
						|
  <code-pane header="hero-profile.component.ts" path="dynamic-component-loader/src/app/hero-profile.component.ts">
 | 
						|
 | 
						|
  </code-pane>
 | 
						|
 | 
						|
  <code-pane header="ad.component.ts" path="dynamic-component-loader/src/app/ad.component.ts">
 | 
						|
 | 
						|
  </code-pane>
 | 
						|
 | 
						|
</code-tabs>
 | 
						|
 | 
						|
 | 
						|
 | 
						|
{@a final-ad-baner}
 | 
						|
 | 
						|
 | 
						|
## Final ad banner
 | 
						|
 The final ad banner looks like this:
 | 
						|
 | 
						|
<div class="lightbox">
 | 
						|
  <img src="generated/images/guide/dynamic-component-loader/ads-example.gif" alt="Ads">
 | 
						|
</div>
 | 
						|
 | 
						|
See the <live-example name="dynamic-component-loader"></live-example>.
 |