@unhead/dom 0.2.5 → 0.2.6

package/README.md

@@ -0,0 +1,12 @@
+# @unhead/dom
+
+## Install
+
+```bash
+# yarn add @unhead/dom
+npm install @unhead/dom
+```
+
+## Documentation
+
+See the [@unhead/dom](https://unhead.harlanzw.com/guide/getting-started/how-it-works#unheaddom) for how this works.

package/dist/index.cjs

@@ -46,10 +46,15 @@ function setAttributesWithSideEffects(head, $el, entry, tag) {
 async function renderDOMHead(head, options = {}) {
   const dom = options.document || window.document;
   const tags = await head.resolveTags();
-  await head.hooks.callHook("dom:beforeRender", { head, tags, document: dom });
-  for (const tag of tags) {
-    const renderCtx = { tag, document: dom, head };
+  const context = { shouldRender: true, tags };
+  await head.hooks.callHook("dom:beforeRender", context);
+  if (!context.shouldRender)
+    return;
+  for (const tag of context.tags) {
+    const renderCtx = { shouldRender: true, tag };
     await head.hooks.callHook("dom:renderTag", renderCtx);
+    if (!renderCtx.shouldRender)
+      return;
     const entry = head.headEntries().find((e) => e._i === Number(tag._e));
     if (tag.tag === "title" && tag.children) {
       dom.title = tag.children;
@@ -99,12 +104,13 @@ async function renderDOMHead(head, options = {}) {
   head._flushQueuedSideEffects();
 }
 exports.domUpdatePromise = null;
-async function debouncedRenderDOMHead(delayedFn, head, options = {}) {
+async function debouncedRenderDOMHead(head, options = {}) {
   function doDomUpdate() {
     exports.domUpdatePromise = null;
     return renderDOMHead(head, options);
   }
-  return exports.domUpdatePromise = exports.domUpdatePromise || new Promise((resolve) => delayedFn(() => resolve(doDomUpdate())));
+  const delayFn = options.delayFn || ((fn) => setTimeout(fn, 25));
+  return exports.domUpdatePromise = exports.domUpdatePromise || new Promise((resolve) => delayFn(() => resolve(doDomUpdate())));
 }
 
 exports.debouncedRenderDOMHead = debouncedRenderDOMHead;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { HeadClient } from '@unhead/schema';
+import { Unhead } from '@unhead/schema';
 
 interface RenderDomHeadOptions {
     /**
@@ -9,7 +9,7 @@ interface RenderDomHeadOptions {
 /**
  * Render the head tags to the DOM.
  */
-declare function renderDOMHead<T extends HeadClient<any>>(head: T, options?: RenderDomHeadOptions): Promise<void>;
+declare function renderDOMHead<T extends Unhead<any>>(head: T, options?: RenderDomHeadOptions): Promise<void>;
 /**
  * Global instance of the dom update promise. Used for debounding head updates.
  */
@@ -17,6 +17,8 @@ declare let domUpdatePromise: Promise<void> | null;
 /**
  * Queue a debounced update of the DOM head.
  */
-declare function debouncedRenderDOMHead<T extends HeadClient<any>>(delayedFn: (fn: () => void) => void, head: T, options?: RenderDomHeadOptions): Promise<void>;
+declare function debouncedRenderDOMHead<T extends Unhead<any>>(head: T, options?: RenderDomHeadOptions & {
+    delayFn?: (fn: () => void) => void;
+}): Promise<void>;
 
 export { RenderDomHeadOptions, debouncedRenderDOMHead, domUpdatePromise, renderDOMHead };

package/dist/index.mjs

@@ -44,10 +44,15 @@ function setAttributesWithSideEffects(head, $el, entry, tag) {
 async function renderDOMHead(head, options = {}) {
   const dom = options.document || window.document;
   const tags = await head.resolveTags();
-  await head.hooks.callHook("dom:beforeRender", { head, tags, document: dom });
-  for (const tag of tags) {
-    const renderCtx = { tag, document: dom, head };
+  const context = { shouldRender: true, tags };
+  await head.hooks.callHook("dom:beforeRender", context);
+  if (!context.shouldRender)
+    return;
+  for (const tag of context.tags) {
+    const renderCtx = { shouldRender: true, tag };
     await head.hooks.callHook("dom:renderTag", renderCtx);
+    if (!renderCtx.shouldRender)
+      return;
     const entry = head.headEntries().find((e) => e._i === Number(tag._e));
     if (tag.tag === "title" && tag.children) {
       dom.title = tag.children;
@@ -97,12 +102,13 @@ async function renderDOMHead(head, options = {}) {
   head._flushQueuedSideEffects();
 }
 let domUpdatePromise = null;
-async function debouncedRenderDOMHead(delayedFn, head, options = {}) {
+async function debouncedRenderDOMHead(head, options = {}) {
   function doDomUpdate() {
     domUpdatePromise = null;
     return renderDOMHead(head, options);
   }
-  return domUpdatePromise = domUpdatePromise || new Promise((resolve) => delayedFn(() => resolve(doDomUpdate())));
+  const delayFn = options.delayFn || ((fn) => setTimeout(fn, 25));
+  return domUpdatePromise = domUpdatePromise || new Promise((resolve) => delayFn(() => resolve(doDomUpdate())));
 }
 
 export { debouncedRenderDOMHead, domUpdatePromise, renderDOMHead };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unhead/dom",
   "type": "module",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "packageManager": "pnpm@7.14.0",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
@@ -30,7 +30,7 @@
     "dist"
   ],
   "dependencies": {
-    "@unhead/schema": "0.2.5"
+    "@unhead/schema": "0.2.6"
   },
   "devDependencies": {
     "zhead": "1.0.0-beta.10"