Skip to content

Commit 9893576

Browse files
jbogarthydemhevery
authored andcommitted
docs(elements): update api doc for custom elements (angular#38252)
by adding cross-references to Angular Elements Overview guide. PR Close angular#38252
1 parent af80bdb commit 9893576

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

packages/elements/src/create-custom-element.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ import {createCustomEvent, getComponentInputs, getDefaultAttributeToPropertyInpu
1818
* that can be used for custom element registration. Implemented and returned
1919
* by the {@link createCustomElement createCustomElement() function}.
2020
*
21+
* @see [Angular Elements Overview](guide/elements "Turning Angular components into custom elements")
22+
*
2123
* @publicApi
2224
*/
2325
export interface NgElementConstructor<P> {
@@ -115,6 +117,8 @@ export interface NgElementConfig {
115117
* static property to affect all newly created instances, or as a constructor argument for
116118
* one-off creations.
117119
*
120+
* @see [Angular Elements Overview](guide/elements "Turning Angular components into custom elements")
121+
*
118122
* @param component The component to transform.
119123
* @param config A configuration that provides initialization information to the created class.
120124
* @returns The custom-element construction class, which can be registered with

0 commit comments

Comments
 (0)