Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
fix: render head slot JSON-LD in document head (#5897)
Oleg Isonen1ef64506aaf3
diff --git a/packages/sdk-components-react/src/head-slot-context.ts b/packages/sdk-components-react/src/head-slot-context.tsnew file mode 100644index 0000000000..b75b4a6c3b--- /dev/null+++ b/packages/sdk-components-react/src/head-slot-context.ts@@ -0,0 +1,3 @@+import { createContext } from "react";++export const HeadSlotContext = createContext(false);diff --git a/packages/sdk-components-react/src/head-slot.tsx b/packages/sdk-components-react/src/head-slot.tsxindex f598634be1..d6e44d3eea 100644--- a/packages/sdk-components-react/src/head-slot.tsx+++ b/packages/sdk-components-react/src/head-slot.tsx@@ -4,6 +4,7 @@ import {type Hook,} from "@webstudio-is/react-sdk/runtime";import { forwardRef, type ElementRef, useContext, type ReactNode } from "react";+import { HeadSlotContext } from "./head-slot-context";import { XmlNode } from "./xml-node";export const defaultTag = "head";@@ -15,7 +16,11 @@ export const HeadSlot = forwardRef<const { renderer } = useContext(ReactSdkContext);if (renderer === undefined) {- return children;+ return (+ <HeadSlotContext.Provider value={true}>+ {children}+ </HeadSlotContext.Provider>+ );}if (props["data-ws-expand"] !== true) {diff --git a/packages/sdk-components-react/src/json-ld-head.test.tsx b/packages/sdk-components-react/src/json-ld-head.test.tsxnew file mode 100644index 0000000000..64d222b1d6--- /dev/null+++ b/packages/sdk-components-react/src/json-ld-head.test.tsx@@ -0,0 +1,39 @@+/**+ * @vitest-environment jsdom+ */+import { cleanup, render, waitFor } from "@testing-library/react";+import { afterEach, expect, test } from "vitest";+import { HeadSlot } from "./head-slot";+import { JsonLd } from "./json-ld";++afterEach(cleanup);++test("renders JSON-LD in the document head when nested in Head Slot", async () => {+ const { container } = render(+ <HeadSlot>+ <JsonLd code={{ "@context": "https://schema.org", name: "Acme" }} />+ </HeadSlot>+ );++ await waitFor(() => {+ expect(+ document.head.querySelector('script[type="application/ld+json"]')+ ).not.toBeNull();+ });+ expect(+ container.querySelector('script[type="application/ld+json"]')+ ).toBeNull();+});++test("keeps JSON-LD in page flow when it is outside Head Slot", () => {+ const { container } = render(+ <JsonLd code={{ "@context": "https://schema.org", name: "Acme" }} />+ );++ expect(+ container.querySelector('script[type="application/ld+json"]')+ ).not.toBeNull();+ expect(+ document.head.querySelector('script[type="application/ld+json"]')+ ).toBeNull();+});diff --git a/packages/sdk-components-react/src/json-ld.tsx b/packages/sdk-components-react/src/json-ld.tsxindex 8aaafdf2b0..df2ab9edea 100644--- a/packages/sdk-components-react/src/json-ld.tsx+++ b/packages/sdk-components-react/src/json-ld.tsx@@ -3,7 +3,16 @@ import {escapeJsonLdScriptText,validateJsonLd,} from "@webstudio-is/sdk/runtime";-import { forwardRef, type ElementRef, type Ref, useContext } from "react";+import {+ forwardRef,+ type ElementRef,+ type Ref,+ useContext,+ useEffect,+ useState,+} from "react";+import { createPortal } from "react-dom";+import { HeadSlotContext } from "./head-slot-context";import { XmlNode } from "./xml-node";export const defaultTag = "script";@@ -19,8 +28,16 @@ const serializeJsonLd = (code: unknown) => {export const JsonLd = forwardRef<ElementRef<"script">, { code?: unknown }>(({ code = "" }, ref) => {const { renderer } = useContext(ReactSdkContext);+ const isInHeadSlot = useContext(HeadSlotContext);+ const [isMounted, setIsMounted] = useState(false);const serialized = serializeJsonLd(code);+ useEffect(() => {+ if (isInHeadSlot) {+ setIsMounted(true);+ }+ }, [isInHeadSlot]);+if (renderer === "canvas") {return (<XmlNode@@ -44,13 +61,19 @@ export const JsonLd = forwardRef<ElementRef<"script">, { code?: unknown }>(return null;}- return (+ const script = (<scriptref={ref}type="application/ld+json"dangerouslySetInnerHTML={{ __html: content }}/>);++ if (isInHeadSlot && isMounted) {+ return createPortal(script, document.head);+ }++ return script;});