docs(core): add docs to instructions, minor renames (#20855)

PR Close #20855
This commit is contained in:
Kara Erickson
2017-12-21 21:40:58 -08:00
committed by Igor Minar
parent 83b27bac17
commit 6cc8f2298e
4 changed files with 199 additions and 88 deletions
+2 -1
View File
@@ -168,7 +168,8 @@ function bloomHashBit(type: viewEngine.Type<any>): number|null {
export function bloomFindPossibleInjector(
startInjector: LNodeInjector, bloomBit: number): LNodeInjector|null {
// Create a mask that targets the specific bit associated with the directive we're looking for.
// This will be a number between 0 and 31, corresponding to a bit position in a 32 bit integer.
// JS bit operations are 32 bits, so this will be a number between 2^0 and 2^31, corresponding
// to bit positions 0 - 31 in a 32 bit integer.
const mask = 1 << bloomBit;
// Traverse up the injector tree until we find a potential match or until we know there *isn't* a
File diff suppressed because it is too large Load Diff
+10 -10
View File
@@ -10,7 +10,7 @@ import {assertNotNull} from './assert';
import {ContainerState, ProjectionState, ViewOrContainerState, ViewState} from './interfaces';
import {LContainer, LElement, LNode, LNodeFlags, LProjection, LText, LView} from './l_node';
import {assertNodeType} from './node_assert';
import {RComment, RElement, RNode, RText, Renderer3Fn} from './renderer';
import {RComment, RElement, RNode, RText, ProceduralRenderer3} from './renderer';
/**
* Finds the closest DOM node above a given container in the hierarchy.
@@ -91,15 +91,15 @@ export function addRemoveViewFromContainer(
const type = node.flags & LNodeFlags.TYPE_MASK;
let nextNode: LNode|null = null;
const renderer = container.view.renderer;
const isFnRenderer = (renderer as Renderer3Fn).listen;
const isFnRenderer = (renderer as ProceduralRenderer3).listen;
if (type === LNodeFlags.Element) {
insertMode ?
(isFnRenderer ?
(renderer as Renderer3Fn)
(renderer as ProceduralRenderer3)
.insertBefore !(parent, node.native !, beforeNode as RNode | null) :
parent.insertBefore(node.native !, beforeNode as RNode | null, true)) :
(isFnRenderer ?
(renderer as Renderer3Fn).removeChild !(parent as RElement, node.native !) :
(renderer as ProceduralRenderer3).removeChild !(parent as RElement, node.native !) :
parent.removeChild(node.native !));
nextNode = node.next;
} else if (type === LNodeFlags.Container) {
@@ -108,10 +108,10 @@ export function addRemoveViewFromContainer(
const childContainerData: ContainerState = (node as LContainer).data;
insertMode ?
(isFnRenderer ?
(renderer as Renderer3Fn).appendChild !(parent as RElement, node.native !) :
(renderer as ProceduralRenderer3).appendChild !(parent as RElement, node.native !) :
parent.appendChild(node.native !)) :
(isFnRenderer ?
(renderer as Renderer3Fn).removeChild !(parent as RElement, node.native !) :
(renderer as ProceduralRenderer3).removeChild !(parent as RElement, node.native !) :
parent.removeChild(node.native !));
nextNode = childContainerData.views.length ? childContainerData.views[0].child : null;
} else if (type === LNodeFlags.Projection) {
@@ -332,8 +332,8 @@ export function appendChild(parent: LNode, child: RNode | null, currentView: Vie
// We only add element if not in View or not projected.
const renderer = currentView.renderer;
(renderer as Renderer3Fn).listen ?
(renderer as Renderer3Fn).appendChild !(parent.native !as RElement, child) :
(renderer as ProceduralRenderer3).listen ?
(renderer as ProceduralRenderer3).appendChild !(parent.native !as RElement, child) :
parent.native !.appendChild(child);
return true;
}
@@ -373,8 +373,8 @@ export function insertChild(node: LNode, currentView: ViewState): void {
sibling = sibling.next;
}
const renderer = currentView.renderer;
(renderer as Renderer3Fn).listen ?
(renderer as Renderer3Fn).insertBefore !(parent.native !, node.native !, nativeSibling) :
(renderer as ProceduralRenderer3).listen ?
(renderer as ProceduralRenderer3).insertBefore !(parent.native !, node.native !, nativeSibling) :
parent.native !.insertBefore(node.native !, nativeSibling, false);
}
}
+6 -12
View File
@@ -24,12 +24,10 @@ export enum RendererStyleFlags3 {
DashCase = 1 << 1
}
export type Renderer3 = Renderer3oo | Renderer3Fn;
export type Renderer3 = ObjectOrientedRenderer3 | ProceduralRenderer3;
/**
* Object Oriented style of API needed to create elements and text nodes.
*/
export interface Renderer3oo {
/** Object Oriented style of API needed to create elements and text nodes. */
export interface ObjectOrientedRenderer3 {
createComment(data: string): RComment;
createElement(tagName: string): RElement;
createTextNode(data: string): RText;
@@ -37,10 +35,8 @@ export interface Renderer3oo {
querySelector(selectors: string): RElement|null;
}
/**
* Functional style of API needed to create elements and text nodes.
*/
export interface Renderer3Fn {
/** Procedural style of API needed to create elements and text nodes. */
export interface ProceduralRenderer3 {
destroy(): void;
createElement(name: string, namespace?: string|null): RElement;
createComment(value: string): RComment;
@@ -77,9 +73,7 @@ export interface RendererFactory3 {
end?(): void;
}
/**
* Subset of API needed for appending elements and text nodes.
*/
/** Subset of API needed for appending elements and text nodes. */
export interface RNode {
removeChild(oldChild: RNode): void;