UNPKG

@tarojs/components

Version:

Taro 组件库

1,182 lines (1,181 loc) • 95.6 kB
const NAMESPACE = 'taro-components'; /** * Virtual DOM patching algorithm based on Snabbdom by * Simon Friis Vindum (@paldepind) * Licensed under the MIT License * https://github.com/snabbdom/snabbdom/blob/master/LICENSE * * Modified for Stencil's renderer and slot projection */ let contentRef; let hostTagName; let useNativeShadowDom = false; let checkSlotFallbackVisibility = false; let checkSlotRelocate = false; let isSvgMode = false; let queuePending = false; const createTime = (fnName, tagName = '') => { { return () => { return; }; } }; const uniqueTime = (key, measureText) => { { return () => { return; }; } }; const CONTENT_REF_ID = 'r'; const ORG_LOCATION_ID = 'o'; const SLOT_NODE_ID = 's'; const TEXT_NODE_ID = 't'; const HYDRATE_ID = 's-id'; const HYDRATED_STYLE_ID = 'sty-id'; const HYDRATE_CHILD_ID = 'c-id'; const HYDRATED_CSS = '{visibility:hidden}.hydrated{visibility:inherit}'; const XLINK_NS = 'http://www.w3.org/1999/xlink'; /** * Default style mode id */ /** * Reusable empty obj/array * Don't add values to these!! */ const EMPTY_OBJ = {}; const isComplexType = (o) => { // https://jsperf.com/typeof-fn-object/5 o = typeof o; return o === 'object' || o === 'function'; }; /** * Helper method for querying a `meta` tag that contains a nonce value * out of a DOM's head. * * @param doc The DOM containing the `head` to query against * @returns The content of the meta tag representing the nonce value, or `undefined` if no tag * exists or the tag has no content. */ function queryNonceMetaTagContent(doc) { var _a, _b, _c; return (_c = (_b = (_a = doc.head) === null || _a === void 0 ? void 0 : _a.querySelector('meta[name="csp-nonce"]')) === null || _b === void 0 ? void 0 : _b.getAttribute('content')) !== null && _c !== void 0 ? _c : undefined; } /** * Production h() function based on Preact by * Jason Miller (@developit) * Licensed under the MIT License * https://github.com/developit/preact/blob/master/LICENSE * * Modified for Stencil's compiler and vdom */ // export function h(nodeName: string | d.FunctionalComponent, vnodeData: d.PropsType, child?: d.ChildType): d.VNode; // export function h(nodeName: string | d.FunctionalComponent, vnodeData: d.PropsType, ...children: d.ChildType[]): d.VNode; const h = (nodeName, vnodeData, ...children) => { let child = null; let key = null; let slotName = null; let simple = false; let lastSimple = false; const vNodeChildren = []; const walk = (c) => { for (let i = 0; i < c.length; i++) { child = c[i]; if (Array.isArray(child)) { walk(child); } else if (child != null && typeof child !== 'boolean') { if ((simple = typeof nodeName !== 'function' && !isComplexType(child))) { child = String(child); } if (simple && lastSimple) { // If the previous child was simple (string), we merge both vNodeChildren[vNodeChildren.length - 1].$text$ += child; } else { // Append a new vNode, if it's text, we create a text vNode vNodeChildren.push(simple ? newVNode(null, child) : child); } lastSimple = simple; } } }; walk(children); if (vnodeData) { // normalize class / classname attributes if (vnodeData.key) { key = vnodeData.key; } if (vnodeData.name) { slotName = vnodeData.name; } { const classData = vnodeData.className || vnodeData.class; if (classData) { vnodeData.class = typeof classData !== 'object' ? classData : Object.keys(classData) .filter((k) => classData[k]) .join(' '); } } } if (typeof nodeName === 'function') { // nodeName is a functional component return nodeName(vnodeData === null ? {} : vnodeData, vNodeChildren, vdomFnUtils); } const vnode = newVNode(nodeName, null); vnode.$attrs$ = vnodeData; if (vNodeChildren.length > 0) { vnode.$children$ = vNodeChildren; } { vnode.$key$ = key; } { vnode.$name$ = slotName; } return vnode; }; /** * A utility function for creating a virtual DOM node from a tag and some * possible text content. * * @param tag the tag for this element * @param text possible text content for the node * @returns a newly-minted virtual DOM node */ const newVNode = (tag, text) => { const vnode = { $flags$: 0, $tag$: tag, $text$: text, $elm$: null, $children$: null, }; { vnode.$attrs$ = null; } { vnode.$key$ = null; } { vnode.$name$ = null; } return vnode; }; const Host = {}; /** * Check whether a given node is a Host node or not * * @param node the virtual DOM node to check * @returns whether it's a Host node or not */ const isHost = (node) => node && node.$tag$ === Host; /** * Implementation of {@link d.FunctionalUtilities} for Stencil's VDom. * * Note that these functions convert from {@link d.VNode} to * {@link d.ChildNode} to give functional component developers a friendly * interface. */ const vdomFnUtils = { forEach: (children, cb) => children.map(convertToPublic).forEach(cb), map: (children, cb) => children.map(convertToPublic).map(cb).map(convertToPrivate), }; /** * Convert a {@link d.VNode} to a {@link d.ChildNode} in order to present a * friendlier public interface (hence, 'convertToPublic'). * * @param node the virtual DOM node to convert * @returns a converted child node */ const convertToPublic = (node) => ({ vattrs: node.$attrs$, vchildren: node.$children$, vkey: node.$key$, vname: node.$name$, vtag: node.$tag$, vtext: node.$text$, }); /** * Convert a {@link d.ChildNode} back to an equivalent {@link d.VNode} in * order to use the resulting object in the virtual DOM. The initial object was * likely created as part of presenting a public API, so converting it back * involved making it 'private' again (hence, `convertToPrivate`). * * @param node the child node to convert * @returns a converted virtual DOM node */ const convertToPrivate = (node) => { if (typeof node.vtag === 'function') { const vnodeData = Object.assign({}, node.vattrs); if (node.vkey) { vnodeData.key = node.vkey; } if (node.vname) { vnodeData.name = node.vname; } return h(node.vtag, vnodeData, ...(node.vchildren || [])); } const vnode = newVNode(node.vtag, node.vtext); vnode.$attrs$ = node.vattrs; vnode.$children$ = node.vchildren; vnode.$key$ = node.vkey; vnode.$name$ = node.vname; return vnode; }; const initializeClientHydrate = (hostElm, tagName, hostId, hostRef) => { const endHydrate = createTime('hydrateClient', tagName); const shadowRoot = hostElm.shadowRoot; const childRenderNodes = []; const slotNodes = []; const shadowRootNodes = null; const vnode = (hostRef.$vnode$ = newVNode(tagName, null)); if (!plt.$orgLocNodes$) { initializeDocumentHydrate(doc.body, (plt.$orgLocNodes$ = new Map())); } hostElm[HYDRATE_ID] = hostId; hostElm.removeAttribute(HYDRATE_ID); clientHydrate(vnode, childRenderNodes, slotNodes, shadowRootNodes, hostElm, hostElm, hostId); childRenderNodes.map((c) => { const orgLocationId = c.$hostId$ + '.' + c.$nodeId$; const orgLocationNode = plt.$orgLocNodes$.get(orgLocationId); const node = c.$elm$; if (orgLocationNode && supportsShadow && orgLocationNode['s-en'] === '') { orgLocationNode.parentNode.insertBefore(node, orgLocationNode.nextSibling); } if (!shadowRoot) { node['s-hn'] = tagName; if (orgLocationNode) { node['s-ol'] = orgLocationNode; node['s-ol']['s-nr'] = node; } } plt.$orgLocNodes$.delete(orgLocationId); }); endHydrate(); }; const clientHydrate = (parentVNode, childRenderNodes, slotNodes, shadowRootNodes, hostElm, node, hostId) => { let childNodeType; let childIdSplt; let childVNode; let i; if (node.nodeType === 1 /* NODE_TYPE.ElementNode */) { childNodeType = node.getAttribute(HYDRATE_CHILD_ID); if (childNodeType) { // got the node data from the element's attribute // `${hostId}.${nodeId}.${depth}.${index}` childIdSplt = childNodeType.split('.'); if (childIdSplt[0] === hostId || childIdSplt[0] === '0') { childVNode = { $flags$: 0, $hostId$: childIdSplt[0], $nodeId$: childIdSplt[1], $depth$: childIdSplt[2], $index$: childIdSplt[3], $tag$: node.tagName.toLowerCase(), $elm$: node, $attrs$: null, $children$: null, $key$: null, $name$: null, $text$: null, }; childRenderNodes.push(childVNode); node.removeAttribute(HYDRATE_CHILD_ID); // this is a new child vnode // so ensure its parent vnode has the vchildren array if (!parentVNode.$children$) { parentVNode.$children$ = []; } // add our child vnode to a specific index of the vnode's children parentVNode.$children$[childVNode.$index$] = childVNode; // this is now the new parent vnode for all the next child checks parentVNode = childVNode; if (shadowRootNodes && childVNode.$depth$ === '0') { shadowRootNodes[childVNode.$index$] = childVNode.$elm$; } } } // recursively drill down, end to start so we can remove nodes for (i = node.childNodes.length - 1; i >= 0; i--) { clientHydrate(parentVNode, childRenderNodes, slotNodes, shadowRootNodes, hostElm, node.childNodes[i], hostId); } if (node.shadowRoot) { // keep drilling down through the shadow root nodes for (i = node.shadowRoot.childNodes.length - 1; i >= 0; i--) { clientHydrate(parentVNode, childRenderNodes, slotNodes, shadowRootNodes, hostElm, node.shadowRoot.childNodes[i], hostId); } } } else if (node.nodeType === 8 /* NODE_TYPE.CommentNode */) { // `${COMMENT_TYPE}.${hostId}.${nodeId}.${depth}.${index}` childIdSplt = node.nodeValue.split('.'); if (childIdSplt[1] === hostId || childIdSplt[1] === '0') { // comment node for either the host id or a 0 host id childNodeType = childIdSplt[0]; childVNode = { $flags$: 0, $hostId$: childIdSplt[1], $nodeId$: childIdSplt[2], $depth$: childIdSplt[3], $index$: childIdSplt[4], $elm$: node, $attrs$: null, $children$: null, $key$: null, $name$: null, $tag$: null, $text$: null, }; if (childNodeType === TEXT_NODE_ID) { childVNode.$elm$ = node.nextSibling; if (childVNode.$elm$ && childVNode.$elm$.nodeType === 3 /* NODE_TYPE.TextNode */) { childVNode.$text$ = childVNode.$elm$.textContent; childRenderNodes.push(childVNode); // remove the text comment since it's no longer needed node.remove(); if (!parentVNode.$children$) { parentVNode.$children$ = []; } parentVNode.$children$[childVNode.$index$] = childVNode; if (shadowRootNodes && childVNode.$depth$ === '0') { shadowRootNodes[childVNode.$index$] = childVNode.$elm$; } } } else if (childVNode.$hostId$ === hostId) { // this comment node is specifcally for this host id if (childNodeType === SLOT_NODE_ID) { // `${SLOT_NODE_ID}.${hostId}.${nodeId}.${depth}.${index}.${slotName}`; childVNode.$tag$ = 'slot'; if (childIdSplt[5]) { node['s-sn'] = childVNode.$name$ = childIdSplt[5]; } else { node['s-sn'] = ''; } node['s-sr'] = true; slotNodes.push(childVNode); if (!parentVNode.$children$) { parentVNode.$children$ = []; } parentVNode.$children$[childVNode.$index$] = childVNode; } else if (childNodeType === CONTENT_REF_ID) { // `${CONTENT_REF_ID}.${hostId}`; { hostElm['s-cr'] = node; node['s-cn'] = true; } } } } } else if (parentVNode && parentVNode.$tag$ === 'style') { const vnode = newVNode(null, node.textContent); vnode.$elm$ = node; vnode.$index$ = '0'; parentVNode.$children$ = [vnode]; } }; const initializeDocumentHydrate = (node, orgLocNodes) => { if (node.nodeType === 1 /* NODE_TYPE.ElementNode */) { let i = 0; for (; i < node.childNodes.length; i++) { initializeDocumentHydrate(node.childNodes[i], orgLocNodes); } if (node.shadowRoot) { for (i = 0; i < node.shadowRoot.childNodes.length; i++) { initializeDocumentHydrate(node.shadowRoot.childNodes[i], orgLocNodes); } } } else if (node.nodeType === 8 /* NODE_TYPE.CommentNode */) { const childIdSplt = node.nodeValue.split('.'); if (childIdSplt[0] === ORG_LOCATION_ID) { orgLocNodes.set(childIdSplt[1] + '.' + childIdSplt[2], node); node.nodeValue = ''; // useful to know if the original location is // the root light-dom of a shadow dom component node['s-en'] = childIdSplt[3]; } } }; /** * Parse a new property value for a given property type. * * While the prop value can reasonably be expected to be of `any` type as far as TypeScript's type checker is concerned, * it is not safe to assume that the string returned by evaluating `typeof propValue` matches: * 1. `any`, the type given to `propValue` in the function signature * 2. the type stored from `propType`. * * This function provides the capability to parse/coerce a property's value to potentially any other JavaScript type. * * Property values represented in TSX preserve their type information. In the example below, the number 0 is passed to * a component. This `propValue` will preserve its type information (`typeof propValue === 'number'`). Note that is * based on the type of the value being passed in, not the type declared of the class member decorated with `@Prop`. * ```tsx * <my-cmp prop-val={0}></my-cmp> * ``` * * HTML prop values on the other hand, will always a string * * @param propValue the new value to coerce to some type * @param propType the type of the prop, expressed as a binary number * @returns the parsed/coerced value */ const parsePropertyValue = (propValue, propType) => { // ensure this value is of the correct prop type if (propValue != null && !isComplexType(propValue)) { if (propType & 4 /* MEMBER_FLAGS.Boolean */) { // per the HTML spec, any string value means it is a boolean true value // but we'll cheat here and say that the string "false" is the boolean false return propValue === 'false' ? false : propValue === '' || !!propValue; } if (propType & 2 /* MEMBER_FLAGS.Number */) { // force it to be a number return parseFloat(propValue); } if (propType & 1 /* MEMBER_FLAGS.String */) { // could have been passed as a number or boolean // but we still want it as a string return String(propValue); } // redundant return here for better minification return propValue; } // not sure exactly what type we want // so no need to change to a different type return propValue; }; const getElement = (ref) => (getHostRef(ref).$hostElement$ ); const createEvent = (ref, name, flags) => { const elm = getElement(ref); return { emit: (detail) => { return emitEvent(elm, name, { bubbles: !!(flags & 4 /* EVENT_FLAGS.Bubbles */), composed: !!(flags & 2 /* EVENT_FLAGS.Composed */), cancelable: !!(flags & 1 /* EVENT_FLAGS.Cancellable */), detail, }); }, }; }; /** * Helper function to create & dispatch a custom Event on a provided target * @param elm the target of the Event * @param name the name to give the custom Event * @param opts options for configuring a custom Event * @returns the custom Event */ const emitEvent = (elm, name, opts) => { const ev = plt.ce(name, opts); elm.dispatchEvent(ev); return ev; }; const rootAppliedStyles = /*@__PURE__*/ new WeakMap(); const registerStyle = (scopeId, cssText, allowCS) => { let style = styles.get(scopeId); if (supportsConstructableStylesheets && allowCS) { style = (style || new CSSStyleSheet()); if (typeof style === 'string') { style = cssText; } else { style.replaceSync(cssText); } } else { style = cssText; } styles.set(scopeId, style); }; const addStyle = (styleContainerNode, cmpMeta, mode, hostElm) => { var _a; let scopeId = getScopeId(cmpMeta); const style = styles.get(scopeId); // if an element is NOT connected then getRootNode() will return the wrong root node // so the fallback is to always use the document for the root node in those cases styleContainerNode = styleContainerNode.nodeType === 11 /* NODE_TYPE.DocumentFragment */ ? styleContainerNode : doc; if (style) { if (typeof style === 'string') { styleContainerNode = styleContainerNode.head || styleContainerNode; let appliedStyles = rootAppliedStyles.get(styleContainerNode); let styleElm; if (!appliedStyles) { rootAppliedStyles.set(styleContainerNode, (appliedStyles = new Set())); } if (!appliedStyles.has(scopeId)) { if (styleContainerNode.host && (styleElm = styleContainerNode.querySelector(`[${HYDRATED_STYLE_ID}="${scopeId}"]`))) { // This is only happening on native shadow-dom, do not needs CSS var shim styleElm.innerHTML = style; } else { { styleElm = doc.createElement('style'); styleElm.innerHTML = style; } // Apply CSP nonce to the style tag if it exists const nonce = (_a = plt.$nonce$) !== null && _a !== void 0 ? _a : queryNonceMetaTagContent(doc); if (nonce != null) { styleElm.setAttribute('nonce', nonce); } styleContainerNode.insertBefore(styleElm, styleContainerNode.querySelector('link')); } if (appliedStyles) { appliedStyles.add(scopeId); } } } else if (!styleContainerNode.adoptedStyleSheets.includes(style)) { styleContainerNode.adoptedStyleSheets = [...styleContainerNode.adoptedStyleSheets, style]; } } return scopeId; }; const attachStyles = (hostRef) => { const cmpMeta = hostRef.$cmpMeta$; const elm = hostRef.$hostElement$; const endAttachStyles = createTime('attachStyles', cmpMeta.$tagName$); addStyle(elm.getRootNode(), cmpMeta); endAttachStyles(); }; const getScopeId = (cmp, mode) => 'sc-' + (cmp.$tagName$); /** * Production setAccessor() function based on Preact by * Jason Miller (@developit) * Licensed under the MIT License * https://github.com/developit/preact/blob/master/LICENSE * * Modified for Stencil's compiler and vdom */ const setAccessor = (elm, memberName, oldValue, newValue, isSvg, flags) => { if (oldValue !== newValue) { let isProp = isMemberInElement(elm, memberName); let ln = memberName.toLowerCase(); if (memberName === 'class') { const classList = elm.classList; const oldClasses = parseClassList(oldValue); const newClasses = parseClassList(newValue); classList.remove(...oldClasses.filter((c) => c && !newClasses.includes(c))); classList.add(...newClasses.filter((c) => c && !oldClasses.includes(c))); } else if (memberName === 'style') { // update style attribute, css properties and values { for (const prop in oldValue) { if (!newValue || newValue[prop] == null) { if (prop.includes('-')) { elm.style.removeProperty(prop); } else { elm.style[prop] = ''; } } } } for (const prop in newValue) { if (!oldValue || newValue[prop] !== oldValue[prop]) { if (prop.includes('-')) { elm.style.setProperty(prop, newValue[prop]); } else { elm.style[prop] = newValue[prop]; } } } } else if (memberName === 'key') ; else if (memberName === 'ref') { // minifier will clean this up if (newValue) { newValue(elm); } } else if ((!isProp ) && memberName[0] === 'o' && memberName[1] === 'n') { // Event Handlers // so if the member name starts with "on" and the 3rd characters is // a capital letter, and it's not already a member on the element, // then we're assuming it's an event listener if (memberName[2] === '-') { // on- prefixed events // allows to be explicit about the dom event to listen without any magic // under the hood: // <my-cmp on-click> // listens for "click" // <my-cmp on-Click> // listens for "Click" // <my-cmp on-ionChange> // listens for "ionChange" // <my-cmp on-EVENTS> // listens for "EVENTS" memberName = memberName.slice(3); } else if (isMemberInElement(win, ln)) { // standard event // the JSX attribute could have been "onMouseOver" and the // member name "onmouseover" is on the window's prototype // so let's add the listener "mouseover", which is all lowercased memberName = ln.slice(2); } else { // custom event // the JSX attribute could have been "onMyCustomEvent" // so let's trim off the "on" prefix and lowercase the first character // and add the listener "myCustomEvent" // except for the first character, we keep the event name case memberName = ln[2] + memberName.slice(3); } if (oldValue) { plt.rel(elm, memberName, oldValue, false); } if (newValue) { plt.ael(elm, memberName, newValue, false); } } else { // Set property if it exists and it's not a SVG const isComplex = isComplexType(newValue); if ((isProp || (isComplex && newValue !== null)) && !isSvg) { try { if (!elm.tagName.includes('-')) { const n = newValue == null ? '' : newValue; // Workaround for Safari, moving the <input> caret when re-assigning the same valued if (memberName === 'list') { isProp = false; } else if (oldValue == null || elm[memberName] != n) { elm[memberName] = n; } } else { elm[memberName] = newValue; } } catch (e) { } } /** * Need to manually update attribute if: * - memberName is not an attribute * - if we are rendering the host element in order to reflect attribute * - if it's a SVG, since properties might not work in <svg> * - if the newValue is null/undefined or 'false'. */ let xlink = false; { if (ln !== (ln = ln.replace(/^xlink\:?/, ''))) { memberName = ln; xlink = true; } } if (newValue == null || newValue === false) { if (newValue !== false || elm.getAttribute(memberName) === '') { if (xlink) { elm.removeAttributeNS(XLINK_NS, memberName); } else { elm.removeAttribute(memberName); } } } else if ((!isProp || flags & 4 /* VNODE_FLAGS.isHost */ || isSvg) && !isComplex) { newValue = newValue === true ? '' : newValue; if (xlink) { elm.setAttributeNS(XLINK_NS, memberName, newValue); } else { elm.setAttribute(memberName, newValue); } } } } }; const parseClassListRegex = /\s/; const parseClassList = (value) => (!value ? [] : value.split(parseClassListRegex)); const updateElement = (oldVnode, newVnode, isSvgMode, memberName) => { // if the element passed in is a shadow root, which is a document fragment // then we want to be adding attrs/props to the shadow root's "host" element // if it's not a shadow root, then we add attrs/props to the same element const elm = newVnode.$elm$.nodeType === 11 /* NODE_TYPE.DocumentFragment */ && newVnode.$elm$.host ? newVnode.$elm$.host : newVnode.$elm$; const oldVnodeAttrs = (oldVnode && oldVnode.$attrs$) || EMPTY_OBJ; const newVnodeAttrs = newVnode.$attrs$ || EMPTY_OBJ; { // remove attributes no longer present on the vnode by setting them to undefined for (memberName in oldVnodeAttrs) { if (!(memberName in newVnodeAttrs)) { setAccessor(elm, memberName, oldVnodeAttrs[memberName], undefined, isSvgMode, newVnode.$flags$); } } } // add new & update changed attributes for (memberName in newVnodeAttrs) { setAccessor(elm, memberName, oldVnodeAttrs[memberName], newVnodeAttrs[memberName], isSvgMode, newVnode.$flags$); } }; /** * Create a DOM Node corresponding to one of the children of a given VNode. * * @param oldParentVNode the parent VNode from the previous render * @param newParentVNode the parent VNode from the current render * @param childIndex the index of the VNode, in the _new_ parent node's * children, for which we will create a new DOM node * @param parentElm the parent DOM node which our new node will be a child of * @returns the newly created node */ const createElm = (oldParentVNode, newParentVNode, childIndex, parentElm) => { // tslint:disable-next-line: prefer-const const newVNode = newParentVNode.$children$[childIndex]; let i = 0; let elm; let childNode; let oldVNode; if (!useNativeShadowDom) { // remember for later we need to check to relocate nodes checkSlotRelocate = true; if (newVNode.$tag$ === 'slot') { newVNode.$flags$ |= newVNode.$children$ ? // slot element has fallback content 2 /* VNODE_FLAGS.isSlotFallback */ : // slot element does not have fallback content 1 /* VNODE_FLAGS.isSlotReference */; } } if (newVNode.$text$ !== null) { // create text node elm = newVNode.$elm$ = doc.createTextNode(newVNode.$text$); } else if (newVNode.$flags$ & 1 /* VNODE_FLAGS.isSlotReference */) { // create a slot reference node elm = newVNode.$elm$ = doc.createTextNode(''); } else { // create element elm = newVNode.$elm$ = (doc.createElement(newVNode.$flags$ & 2 /* VNODE_FLAGS.isSlotFallback */ ? 'slot-fb' : newVNode.$tag$)); // add css classes, attrs, props, listeners, etc. { updateElement(null, newVNode, isSvgMode); } if (newVNode.$children$) { for (i = 0; i < newVNode.$children$.length; ++i) { // create the node childNode = createElm(oldParentVNode, newVNode, i); // return node could have been null if (childNode) { // append our new node elm.appendChild(childNode); } } } } { elm['s-hn'] = hostTagName; if (newVNode.$flags$ & (2 /* VNODE_FLAGS.isSlotFallback */ | 1 /* VNODE_FLAGS.isSlotReference */)) { // remember the content reference comment elm['s-sr'] = true; // remember the content reference comment elm['s-cr'] = contentRef; // remember the slot name, or empty string for default slot elm['s-sn'] = newVNode.$name$ || ''; // check if we've got an old vnode for this slot oldVNode = oldParentVNode && oldParentVNode.$children$ && oldParentVNode.$children$[childIndex]; if (oldVNode && oldVNode.$tag$ === newVNode.$tag$ && oldParentVNode.$elm$) { // we've got an old slot vnode and the wrapper is being replaced // so let's move the old slot content back to it's original location putBackInOriginalLocation(oldParentVNode.$elm$, false); } } } return elm; }; const putBackInOriginalLocation = (parentElm, recursive) => { plt.$flags$ |= 1 /* PLATFORM_FLAGS.isTmpDisconnected */; const oldSlotChildNodes = parentElm.childNodes; for (let i = oldSlotChildNodes.length - 1; i >= 0; i--) { const childNode = oldSlotChildNodes[i]; if (childNode['s-hn'] !== hostTagName && childNode['s-ol']) { // // this child node in the old element is from another component // // remove this node from the old slot's parent // childNode.remove(); // and relocate it back to it's original location parentReferenceNode(childNode).insertBefore(childNode, referenceNode(childNode)); // remove the old original location comment entirely // later on the patch function will know what to do // and move this to the correct spot in need be childNode['s-ol'].remove(); childNode['s-ol'] = undefined; checkSlotRelocate = true; } if (recursive) { putBackInOriginalLocation(childNode, recursive); } } plt.$flags$ &= ~1 /* PLATFORM_FLAGS.isTmpDisconnected */; }; /** * Create DOM nodes corresponding to a list of {@link d.Vnode} objects and * add them to the DOM in the appropriate place. * * @param parentElm the DOM node which should be used as a parent for the new * DOM nodes * @param before a child of the `parentElm` which the new children should be * inserted before (optional) * @param parentVNode the parent virtual DOM node * @param vnodes the new child virtual DOM nodes to produce DOM nodes for * @param startIdx the index in the child virtual DOM nodes at which to start * creating DOM nodes (inclusive) * @param endIdx the index in the child virtual DOM nodes at which to stop * creating DOM nodes (inclusive) */ const addVnodes = (parentElm, before, parentVNode, vnodes, startIdx, endIdx) => { let containerElm = ((parentElm['s-cr'] && parentElm['s-cr'].parentNode) || parentElm); let childNode; for (; startIdx <= endIdx; ++startIdx) { if (vnodes[startIdx]) { childNode = createElm(null, parentVNode, startIdx); if (childNode) { vnodes[startIdx].$elm$ = childNode; containerElm.insertBefore(childNode, referenceNode(before) ); } } } }; /** * Remove the DOM elements corresponding to a list of {@link d.VNode} objects. * This can be used to, for instance, clean up after a list of children which * should no longer be shown. * * This function also handles some of Stencil's slot relocation logic. * * @param vnodes a list of virtual DOM nodes to remove * @param startIdx the index at which to start removing nodes (inclusive) * @param endIdx the index at which to stop removing nodes (inclusive) * @param vnode a VNode * @param elm an element */ const removeVnodes = (vnodes, startIdx, endIdx, vnode, elm) => { for (; startIdx <= endIdx; ++startIdx) { if ((vnode = vnodes[startIdx])) { elm = vnode.$elm$; callNodeRefs(vnode); { // we're removing this element // so it's possible we need to show slot fallback content now checkSlotFallbackVisibility = true; if (elm['s-ol']) { // remove the original location comment elm['s-ol'].remove(); } else { // it's possible that child nodes of the node // that's being removed are slot nodes putBackInOriginalLocation(elm, true); } } // remove the vnode's element from the dom elm.remove(); } } }; /** * Reconcile the children of a new VNode with the children of an old VNode by * traversing the two collections of children, identifying nodes that are * conserved or changed, calling out to `patch` to make any necessary * updates to the DOM, and rearranging DOM nodes as needed. * * The algorithm for reconciling children works by analyzing two 'windows' onto * the two arrays of children (`oldCh` and `newCh`). We keep track of the * 'windows' by storing start and end indices and references to the * corresponding array entries. Initially the two 'windows' are basically equal * to the entire array, but we progressively narrow the windows until there are * no children left to update by doing the following: * * 1. Skip any `null` entries at the beginning or end of the two arrays, so * that if we have an initial array like the following we'll end up dealing * only with a window bounded by the highlighted elements: * * [null, null, VNode1 , ... , VNode2, null, null] * ^^^^^^ ^^^^^^ * * 2. Check to see if the elements at the head and tail positions are equal * across the windows. This will basically detect elements which haven't * been added, removed, or changed position, i.e. if you had the following * VNode elements (represented as HTML): * * oldVNode: `<div><p><span>HEY</span></p></div>` * newVNode: `<div><p><span>THERE</span></p></div>` * * Then when comparing the children of the `<div>` tag we check the equality * of the VNodes corresponding to the `<p>` tags and, since they are the * same tag in the same position, we'd be able to avoid completely * re-rendering the subtree under them with a new DOM element and would just * call out to `patch` to handle reconciling their children and so on. * * 3. Check, for both windows, to see if the element at the beginning of the * window corresponds to the element at the end of the other window. This is * a heuristic which will let us identify _some_ situations in which * elements have changed position, for instance it _should_ detect that the * children nodes themselves have not changed but merely moved in the * following example: * * oldVNode: `<div><element-one /><element-two /></div>` * newVNode: `<div><element-two /><element-one /></div>` * * If we find cases like this then we also need to move the concrete DOM * elements corresponding to the moved children to write the re-order to the * DOM. * * 4. Finally, if VNodes have the `key` attribute set on them we check for any * nodes in the old children which have the same key as the first element in * our window on the new children. If we find such a node we handle calling * out to `patch`, moving relevant DOM nodes, and so on, in accordance with * what we find. * * Finally, once we've narrowed our 'windows' to the point that either of them * collapse (i.e. they have length 0) we then handle any remaining VNode * insertion or deletion that needs to happen to get a DOM state that correctly * reflects the new child VNodes. If, for instance, after our window on the old * children has collapsed we still have more nodes on the new children that * we haven't dealt with yet then we need to add them, or if the new children * collapse but we still have unhandled _old_ children then we need to make * sure the corresponding DOM nodes are removed. * * @param parentElm the node into which the parent VNode is rendered * @param oldCh the old children of the parent node * @param newVNode the new VNode which will replace the parent * @param newCh the new children of the parent node */ const updateChildren = (parentElm, oldCh, newVNode, newCh) => { let oldStartIdx = 0; let newStartIdx = 0; let idxInOld = 0; let i = 0; let oldEndIdx = oldCh.length - 1; let oldStartVnode = oldCh[0]; let oldEndVnode = oldCh[oldEndIdx]; let newEndIdx = newCh.length - 1; let newStartVnode = newCh[0]; let newEndVnode = newCh[newEndIdx]; let node; let elmToMove; while (oldStartIdx <= oldEndIdx && newStartIdx <= newEndIdx) { if (oldStartVnode == null) { // VNode might have been moved left oldStartVnode = oldCh[++oldStartIdx]; } else if (oldEndVnode == null) { oldEndVnode = oldCh[--oldEndIdx]; } else if (newStartVnode == null) { newStartVnode = newCh[++newStartIdx]; } else if (newEndVnode == null) { newEndVnode = newCh[--newEndIdx]; } else if (isSameVnode(oldStartVnode, newStartVnode)) { // if the start nodes are the same then we should patch the new VNode // onto the old one, and increment our `newStartIdx` and `oldStartIdx` // indices to reflect that. We don't need to move any DOM Nodes around // since things are matched up in order. patch(oldStartVnode, newStartVnode); oldStartVnode = oldCh[++oldStartIdx]; newStartVnode = newCh[++newStartIdx]; } else if (isSameVnode(oldEndVnode, newEndVnode)) { // likewise, if the end nodes are the same we patch new onto old and // decrement our end indices, and also likewise in this case we don't // need to move any DOM Nodes. patch(oldEndVnode, newEndVnode); oldEndVnode = oldCh[--oldEndIdx]; newEndVnode = newCh[--newEndIdx]; } else if (isSameVnode(oldStartVnode, newEndVnode)) { // case: "Vnode moved right" // // We've found that the last node in our window on the new children is // the same VNode as the _first_ node in our window on the old children // we're dealing with now. Visually, this is the layout of these two // nodes: // // newCh: [..., newStartVnode , ... , newEndVnode , ...] // ^^^^^^^^^^^ // oldCh: [..., oldStartVnode , ... , oldEndVnode , ...] // ^^^^^^^^^^^^^ // // In this situation we need to patch `newEndVnode` onto `oldStartVnode` // and move the DOM element for `oldStartVnode`. if ((oldStartVnode.$tag$ === 'slot' || newEndVnode.$tag$ === 'slot')) { putBackInOriginalLocation(oldStartVnode.$elm$.parentNode, false); } patch(oldStartVnode, newEndVnode); // We need to move the element for `oldStartVnode` into a position which // will be appropriate for `newEndVnode`. For this we can use // `.insertBefore` and `oldEndVnode.$elm$.nextSibling`. If there is a // sibling for `oldEndVnode.$elm$` then we want to move the DOM node for // `oldStartVnode` between `oldEndVnode` and it's sibling, like so: // // <old-start-node /> // <some-intervening-node /> // <old-end-node /> // <!-- -> <-- `oldStartVnode.$elm$` should be inserted here // <next-sibling /> // // If instead `oldEndVnode.$elm$` has no sibling then we just want to put // the node for `oldStartVnode` at the end of the children of // `parentElm`. Luckily, `Node.nextSibling` will return `null` if there // aren't any siblings, and passing `null` to `Node.insertBefore` will // append it to the children of the parent element. parentElm.insertBefore(oldStartVnode.$elm$, oldEndVnode.$elm$.nextSibling); oldStartVnode = oldCh[++oldStartIdx]; newEndVnode = newCh[--newEndIdx]; } else if (isSameVnode(oldEndVnode, newStartVnode)) { // case: "Vnode moved left" // // We've found that the first node in our window on the new children is // the same VNode as the _last_ node in our window on the old children. // Visually, this is the layout of these two nodes: // // newCh: [..., newStartVnode , ... , newEndVnode , ...] // ^^^^^^^^^^^^^ // oldCh: [..., oldStartVnode , ... , oldEndVnode , ...] // ^^^^^^^^^^^ // // In this situation we need to patch `newStartVnode` onto `oldEndVnode` // (which will handle updating any changed attributes, reconciling their // children etc) but we also need to move the DOM node to which // `oldEndVnode` corresponds. if ((oldStartVnode.$tag$ === 'slot' || newEndVnode.$tag$ === 'slot')) { putBackInOriginalLocation(oldEndVnode.$elm$.parentNode, false); } patch(oldEndVnode, newStartVnode); // We've already checked above if `oldStartVnode` and `newStartVnode` are // the same node, so since we're here we know that they are not. Thus we // can move the element for `oldEndVnode` _before_ the element for // `oldStartVnode`, leaving `oldStartVnode` to be reconciled in the // future. parentElm.insertBefore(oldEndVnode.$elm$, oldStartVnode.$elm$); oldEndVnode = oldCh[--oldEndIdx]; newStartVnode = newCh[++newStartIdx]; } else { // Here we do some checks to match up old and new nodes based on the // `$key$` attribute, which is set by putting a `key="my-key"` attribute // in the JSX for a DOM element in the implementation of a Stencil // component. // // First we check to see if there are any nodes in the array of old // children which have the same key as the first node in the new // children. idxInOld = -1; { for (i = oldStartIdx; i <= oldEndIdx; ++i) { if (oldCh[i] && oldCh[i].$key$ !== null && oldCh[i].$key$ === newStartVnode.$key$) { idxInOld = i; break; } } } if (idxInOld >= 0) { // We found a node in the old children which matches up with the first // node in the new children! So let's deal with that elmToMove = oldCh[idxInOld]; if (elmToMove.$tag$ !== newStartVnode.$tag$) { // the tag doesn't match so we'll need a new DOM element node = createElm(oldCh && oldCh[newStartIdx], newVNode, idxInOld); } else { patch(elmToMove, newStartVnode); // invalidate the matching old node so that we won't try to update it // again later on oldCh[idxInOld] = undefined; node = elmToMove.$elm$; } newStartVnode = newCh[++newStartIdx]; } else { // We either didn't find an element in the old children that matches // the key of the first new child OR the build is not using `key` // attributes at all. In either case we need to create a new element // for the new node. node = createElm(oldCh && oldCh[newStartIdx], newVNode, newStartIdx); newStartVnode = newCh[++newStartIdx]; } if (node) { // if we created a new node then handle inserting it to the DOM { parentReferenceNode(oldStartVnode.$elm$).insertBefore(node, referenceNode(oldStartVnode.$elm$)); } } } } if (oldStartIdx > oldEndIdx) { // we have some more new nodes to add which don't match up with old nodes addVnodes(parentElm, newCh[newEndIdx + 1] == null ? null : newCh[newEndIdx + 1].$elm$, newVNode, newCh, newStartIdx, newEndIdx); } else if (newStartIdx > newEndIdx) { // there are nodes in the `oldCh` array which no longer correspond to nodes // in the new array, so lets remove them (which entails cleaning up the // relevant DOM nodes) removeVnodes(oldCh, oldStartIdx, oldEndIdx); } }; /** * Compare two VNodes to determine if they are the same * * **NB**: This function is an equality _heuristic_ based on the available * information set on the two VNodes and can be misleading under certain * circumstances. In particular, if the two nodes do not have `key` attrs * (available under `$key$` on VNodes) then the function falls back on merely * checking that they have the same tag. * * So, in other words, if `key` attrs are not set on VNodes which may be * changing order within a `children` array or something along those lines then * we could obtain a false negative and then have to do needless re-rendering * (i.e. we'd say two VNodes aren't equal when in fact they should be). * * @param leftVNode the first VNode to check * @param rightVNode the second VNode to check * @returns whether they're equal or not */ const isSameVnode = (leftVNode, rightVNode) => { // compare if two vnode to see if they're "technically" the same // need to have the same element tag, and same key to be the same if (leftVNode.$tag$ === rightVNode.$tag$) { if (leftVNode.$tag$ === 'slot') { return leftVNode.$name$ === rightVNode.$name$; } // this will be set if components in the build have `key` attrs set on them { return leftVNode.$key$ === rightVNode.$key$; } } return false; }; const referenceNode = (node) => { // this node was relocated to a new location in the dom // because of some other component's slot // but we still have an html comment in place of where // it's original location was according to it's original vdom return (node && node['s-ol']) || node; }; const parentReferenceNode = (node) => (node['s-ol'] ? node['s-ol'] : node).parentNode; /** * Handle reconciling an outdated VNode with a new one which corresponds to * it. This function handles flushing updates to the DOM and reconciling the * children of the two nodes (if any). * * @param oldVNode an old VNode whose DOM element and children we want to update * @param newVNode a new VNode representing an updated version of the old one */ const patch = (oldVNode, newVNode) => { cons