217 lines
14 KiB
Markdown
217 lines
14 KiB
Markdown
# Angular Elements Overview
|
||
|
||
_Angular elements_ are Angular components packaged as _custom elements_, a web standard for defining new HTML elements in a framework-agnostic way.
|
||
|
||
[Custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) are a Web Platform feature currently supported by Chrome, Opera, and Safari, and available in other browsers through polyfills (see [Browser Support](#browser-support)).
|
||
A custom element extends HTML by allowing you to define a tag whose content is created and controlled by JavaScript code.
|
||
The browser maintains a `CustomElementRegistry` of defined custom elements (also called Web Components), which maps an instantiable JavaScript class to an HTML tag.
|
||
|
||
The `@angular/elements` package exports a `createCustomElement()` API that provides a bridge from Angular's component interface and change detection functionality to the built-in DOM API.
|
||
|
||
Transforming a component to a custom element makes all of the required Angular infrastructure available to the browser.
|
||
Creating a custom element is simple and straightforward, and automatically connects your component-defined view with change detection and data binding, mapping Angular functionality to the corresponding native HTML equivalents.
|
||
|
||
<div class="alert is-helpful">
|
||
|
||
We are working on custom elements that can be used by web apps built on other frameworks.
|
||
A minimal, self-contained version of the Angular framework will be injected as a service to support the component's change-detection and data-binding functionality.
|
||
For more about the direction of development, check out this [video presentation](https://www.youtube.com/watch?v=Z1gLFPLVJjY&t=4s).
|
||
|
||
</div>
|
||
|
||
## Using custom elements
|
||
|
||
Custom elements bootstrap themselves - they start automatically when they are added to the DOM, and are automatically destroyed when removed from the DOM. Once a custom element is added to the DOM for any page, it looks and behaves like any other HTML element, and does not require any special knowledge of Angular terms or usage conventions.
|
||
|
||
- <b>Easy dynamic content in an Angular app</b>
|
||
|
||
Transforming a component to a custom element provides an easy path to creating dynamic HTML content in your Angular app. HTML content that you add directly to the DOM in an Angular app is normally displayed without Angular processing, unless you define a _dynamic component_, adding your own code to connect the HTML tag to your app data, and participate in change detection. With a custom element, all of that wiring is taken care of automatically.
|
||
|
||
- <b>Content-rich applications</b>
|
||
|
||
If you have a content-rich app, such as the Angular app that presents this documentation, custom elements let you give your content providers sophisticated Angular functionality without requiring knowledge of Angular. For example, an Angular guide like this one is added directly to the DOM by the Angular navigation tools, but can include special elements like `<code-snippet>` that perform complex operations. All you need to tell your content provider is the syntax of your custom element. They don't need to know anything about Angular, or anything about your component's data structures or implementation.
|
||
|
||
### How it works
|
||
|
||
Use the `createCustomElement()` function to convert a component into a class that can be registered with the browser as a custom element.
|
||
After you register your configured class with the browser's custom-element registry, you can use the new element just like a built-in HTML element in content that you add directly into the DOM:
|
||
|
||
```
|
||
<my-popup message="Use Angular!"></my-popup>
|
||
```
|
||
|
||
When your custom element is placed on a page, the browser creates an instance of the registered class and adds it to the DOM. The content is provided by the component's template, which uses Angular template syntax, and is rendered using the component and DOM data. Input properties in the component correspond to input attributes for the element.
|
||
|
||
<figure>
|
||
|
||
<img src="generated/images/guide/elements/customElement1.png" alt="Custom element in browser" class="left">
|
||
|
||
</figure>
|
||
|
||
<hr class="clear">
|
||
|
||
## Transforming components to custom elements
|
||
|
||
Angular provides the `createCustomElement()` function for converting an Angular component,
|
||
together with its dependencies, to a custom element. The function collects the component's
|
||
observable properties, along with the Angular functionality the browser needs to
|
||
create and destroy instances, and to detect and respond to changes.
|
||
|
||
The conversion process implements the `NgElementConstructor` interface, and creates a
|
||
constructor class that is configured to produce a self-bootstrapping instance of your component.
|
||
|
||
Use a JavaScript function, `customElements.define()`, to register the configured constructor
|
||
and its associated custom-element tag with the browser's `CustomElementRegistry`.
|
||
When the browser encounters the tag for the registered element, it uses the constructor to create a custom-element instance.
|
||
|
||
<figure>
|
||
|
||
<img src="generated/images/guide/elements/createElement.png" alt="Transform a component to a custom element" class="left">
|
||
|
||
</figure>
|
||
|
||
### Mapping
|
||
|
||
A custom element _hosts_ an Angular component, providing a bridge between the data and logic defined in the component and standard DOM APIs. Component properties and logic maps directly into HTML attributes and the browser's event system.
|
||
|
||
- The creation API parses the component looking for input properties, and defines corresponding attributes for the custom element. It transforms the property names to make them compatible with custom elements, which do not recognize case distinctions. The resulting attribute names use dash-separated lowercase. For example, for a component with `@Input('myInputProp') inputProp`, the corresponding custom element defines an attribute `my-input-prop`.
|
||
|
||
- Component outputs are dispatched as HTML [Custom Events](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent), with the name of the custom event matching the output name. For example, for a component with `@Output() valueChanged = new EventEmitter()`, the corresponding custom element will dispatch events with the name "valueChanged", and the emitted data will be stored on the event’s `detail` property. If you provide an alias, that value is used; for example, `@Output('myClick') clicks = new EventEmitter<string>();` results in dispatch events with the name "myClick".
|
||
|
||
|
||
For more information, see Web Component documentation for [Creating custom events](https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Creating_and_triggering_events#Creating_custom_events).
|
||
|
||
|
||
{@a browser-support}
|
||
|
||
## Browser support for custom elements
|
||
|
||
The recently-developed [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) Web Platform feature is currently supported natively in a number of browsers. Support is pending or planned in other browsers.
|
||
|
||
<table>
|
||
<tr>
|
||
<th>Browser</th>
|
||
<th>Custom Element Support</th>
|
||
</tr>
|
||
<tr>
|
||
<td>Chrome</td>
|
||
<td>Supported natively.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Opera</td>
|
||
<td>Supported natively.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Safari</td>
|
||
<td>Supported natively.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Firefox</td>
|
||
<td> Set the <code>dom.webcomponents.enabled</code> and <code>dom.webcomponents.customelements.enabled</code> preferences to true. Planned to be enabled by default in version 63.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Edge</td>
|
||
<td>Working on an implementation. <br>
|
||
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
In browsers that support Custom Elements natively, the specification requires developers use ES2015 classes to define Custom Elements - developers can opt-in to this by setting the `target: "es2015"` property in their project's `tsconfig.json`. As Custom Element and ES2015 support may not be available in all browsers, developers can instead choose to use a polyfill to support older browsers and ES5 code.
|
||
|
||
Use the [Angular CLI](cli) to automatically set up your project with the correct polyfill: `ng add @angular/elements --name=*your_project_name*`.
|
||
- For more information about polyfills, see [polyfill documentation](https://www.webcomponents.org/polyfills).
|
||
|
||
- For more information about Angular browser support, see [Browser Support](guide/browser-support).
|
||
|
||
|
||
## Example: A Popup Service
|
||
|
||
Previously, when you wanted to add a component to an app at runtime, you had to define a _dynamic component_. The app module would have to list your dynamic component under `entryComponents`, so that the app wouldn't expect it to be present at startup, and then you would have to load it, attach it to an element in the DOM, and wire up all of the dependencies, change detection, and event handling, as described in [Dynamic Component Loader](guide/dynamic-component-loader).
|
||
|
||
Using an Angular custom element makes the process much simpler and more transparent, by providing all of the infrastructure and framework automatically—all you have to do is define the kind of event handling you want. (You do still have to exclude the component from compilation, if you are not going to use it in your app.)
|
||
|
||
The Popup Service example app (shown below) defines a component that you can either load dynamically or convert to a custom element.
|
||
|
||
- `popup.component.ts` defines a simple pop-up element that displays an input message, with some animation and styling.
|
||
- `popup.service.ts` creates an injectable service that provides two different ways to invoke the PopupComponent; as a dynamic component, or as a custom element. Notice how much more setup is required for the dynamic-loading method.
|
||
- `app.module.ts` adds the PopupComponent in the module's `entryComponents` list, to exclude it from compilation and avoid startup warnings or errors.
|
||
- `app.component.ts` defines the app's root component, which uses the PopupService to add the pop-up to the DOM at run time. When the app runs, the root component's constructor converts PopupComponent to a custom element.
|
||
|
||
For comparison, the demo shows both methods. One button adds the popup using the dynamic-loading method, and the other uses the custom element. You can see that the result is the same; only the preparation is different.
|
||
|
||
<code-tabs>
|
||
|
||
<code-pane header="popup.component.ts" path="elements/src/app/popup.component.ts">
|
||
|
||
</code-pane>
|
||
|
||
<code-pane header="popup.service.ts" path="elements/src/app/popup.service.ts">
|
||
|
||
</code-pane>
|
||
|
||
<code-pane header="app.module.ts" path="elements/src/app/app.module.ts">
|
||
|
||
</code-pane>
|
||
|
||
<code-pane header="app.component.ts" path="elements/src/app/app.component.ts">
|
||
|
||
</code-pane>
|
||
</code-tabs>
|
||
|
||
<!--
|
||
StackBlitz transpiles code to ES5. The live example will not work without a polyfill.
|
||
Only offer a `.zip` to download for now.
|
||
-->
|
||
You can download the full code for the example <live-example downloadOnly>here</live-example>.
|
||
|
||
|
||
## Typings for custom elements
|
||
|
||
Generic DOM APIs, such as `document.createElement()` or `document.querySelector()`, return an element type that is appropriate for the specified arguments. For example, calling `document.createElement('a')` will return an `HTMLAnchorElement`, which TypeScript knows has an `href` property. Similarly, `document.createElement('div')` will return an `HTMLDivElement`, which TypeScript knows has no `href` property.
|
||
|
||
When called with unknown elements, such as a custom element name (`popup-element` in our example), the methods will return a generic type, such as `HTMLELement`, since TypeScript can't infer the correct type of the returned element.
|
||
|
||
Custom elements created with Angular extend `NgElement` (which in turn extends `HTMLElement`). Additionally, these custom elements will have a property for each input of the corresponding component. For example, our `popup-element` will have a `message` property of type `string`.
|
||
|
||
There are a few options if you want to get correct types for your custom elements. Let's assume you create a `my-dialog` custom element based on the following component:
|
||
|
||
```ts
|
||
@Component(...)
|
||
class MyDialog {
|
||
@Input() content: string;
|
||
}
|
||
```
|
||
|
||
The most straight forward way to get accurate typings is to cast the return value of the relevant DOM methods to the correct type. For that, you can use the `NgElement` and `WithProperties` types (both exported from `@angular/elements`):
|
||
|
||
```ts
|
||
const aDialog = document.createElement('my-dialog') as NgElement & WithProperties<{content: string}>;
|
||
aDialog.content = 'Hello, world!';
|
||
aDialog.content = 123; // <-- ERROR: TypeScript knows this should be a string.
|
||
aDialog.body = 'News'; // <-- ERROR: TypeScript knows there is no `body` property on `aDialog`.
|
||
```
|
||
|
||
This is a good way to quickly get TypeScript features, such as type checking and autocomplete support, for you custom element. But it can get cumbersome if you need it in several places, because you have to cast the return type on every occurrence.
|
||
|
||
An alternative way, that only requires defining each custom element's type once, is augmenting the `HTMLELementTagNameMap`, which TypeScript uses to infer the type of a returned element based on its tag name (for DOM methods such as `document.createElement()`, `document.querySelector()`, etc.):
|
||
|
||
```ts
|
||
declare global {
|
||
interface HTMLElementTagNameMap {
|
||
'my-dialog': NgElement & WithProperties<{content: string}>;
|
||
'my-other-element': NgElement & WithProperties<{foo: 'bar'}>;
|
||
...
|
||
}
|
||
}
|
||
```
|
||
|
||
Now, TypeScript can infer the correct type the same way it does for built-in elements:
|
||
|
||
```ts
|
||
document.createElement('div') //--> HTMLDivElement (built-in element)
|
||
document.querySelector('foo') //--> Element (unknown element)
|
||
document.createElement('my-dialog') //--> NgElement & WithProperties<{content: string}> (custom element)
|
||
document.querySelector('my-other-element') //--> NgElement & WithProperties<{foo: 'bar'}> (custom element)
|
||
```
|