cargdev/angular
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: technical review incorporated (#24744)

Browse Source 
closes #24744
This commit is contained in:
Judy Bogart
2018-07-18 10:26:59 -07:00
committed by Victor Berchet
parent f1ab394218
commit 7960d1879d
5 changed files with 37 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
packages/core/src/render/api.ts
View File

@ -128,7 +128,7 @@ export interface RendererType2 {
* DOM elements. One of
* - `Emulated` (default): Emulate native scoping of styles.
* - `Native`: Use the native encapsulation mechanism of the renderer.
* - `ShadowDoc`: Use modern [Shadow
* - `ShadowDom`: Use modern [Shadow
* DOM](https://w3c.github.io/webcomponents/spec/shadow/) and
* create a ShadowRoot for component's host element.
* - `None`: Do not provide any template or style encapsulation.
@ -152,7 +152,7 @@ export interface RendererType2 {
*/
export abstract class RendererFactory2 {
/**
* Implements a custom renderer for a host DOM element.
* Creates and initializes a custom renderer for a host DOM element.
* @param hostElement The element to render.
* @param type The base class to implement.
* @returns The new custom renderer instance.
@ -195,17 +195,17 @@ export enum RendererStyleFlags2 {
*
* Create your custom renderer using `RendererFactory2`.
*
* Use a custom renderer to bypass Angular's templating and make custom UI changes that can't be
* expressed declaratively.
* Use a custom renderer to bypass Angular's templating and
* make custom UI changes that can't be expressed declaratively.
* For example if you need to set a property or an attribute whose name is
* not statically known, use the `setElementProperty()` or
* `setElementAttribute()` method.
* not statically known, use the `setProperty()` or
* `setAttribute()` method.
*
* @experimental
*/
export abstract class Renderer2 {
/**
* Implement this callback to store arbitrary developer-defined data on a renderer instance,
* Use to store arbitrary developer-defined data on a renderer instance,
* as an object containing key-value pairs.
* This is useful for renderers that delegate to other renderers.
*/
@ -262,7 +262,8 @@ export abstract class Renderer2 {
*/
abstract removeChild(parent: any, oldChild: any): void;
/**
* Implement this callback to get the root element of a DOM element.
* Implement this callback to prepare an element to be bootstrapped
* as a root element, and return the element instance.
* @param selectorOrNode The DOM element.
* @returns The root element.
*/
@ -355,6 +356,7 @@ export abstract class Renderer2 {
* DOM element.
* @param eventName The event to listen for.
* @param callback A handler function to invoke when the event occurs.
* @returns An "unlisten" function for disposing of this handler.
*/
abstract listen(
target: 'window'|'document'|'body'|any, eventName: string,