feat: add syncHostStyles API to disable iframe style sync

measuredco · Sep 1, 2024 · 8d701fc · 8d701fc
1 parent 6d43ba0
commit 8d701fc
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 8 deletions.
diff --git a/apps/demo/app/[...puckPath]/client.tsx b/apps/demo/app/[...puckPath]/client.tsx
@@ -17,6 +17,7 @@ export function Client({ path, isEdit }: { path: string; isEdit: boolean }) {
         <Puck<UserConfig>
           config={config}
           data={data}
+          iframe={{ syncHostStyles: false }}
           onPublish={async (data: Data) => {
             localStorage.setItem(key, JSON.stringify(data));
           }}

diff --git a/apps/docs/pages/docs/api-reference/components/puck.mdx b/apps/docs/pages/docs/api-reference/components/puck.mdx
@@ -173,16 +173,23 @@ export function Editor() {
 
 #### iframe params
 
-| Param                 | Example          | Type    | Status |
-| --------------------- | ---------------- | ------- | ------ |
-| [`enabled`](#enabled) | `enabled: false` | boolean | -      |
+| Param                               | Example                 | Type    | Status |
+| ----------------------------------- | ----------------------- | ------- | ------ |
+| [`enabled`](#enabled)               | `enabled: false`        | boolean | -      |
+| [`syncHostStyles`](#syncHostStyles) | `syncHostStyles: false` | boolean | -      |
 
 ##### `enabled`
 
 Render the Puck preview within iframe. Defaults to `true`.
 
 Disabling iframes will also disable [viewports](#viewports).
 
+##### `syncHostStyles`
+
+Sync the host styles to the iframe. Defaults to `true`.
+
+If this isn't working, you may need to inject styles manually using the iframe [override API](/docs/api-reference/overrides/iframe), or make use of a [plugin](/docs/extending-puck/plugins).
+
 ### `initialHistory`
 
 Sets the undo/redo Puck history state when using the `usePuck` [history API](/docs/api-reference/functions/use-puck#history).

diff --git a/packages/core/components/AutoFrame/index.tsx b/packages/core/components/AutoFrame/index.tsx
@@ -60,16 +60,24 @@ const CopyHostStyles = ({
   children,
   debug = false,
   onStylesLoaded = () => null,
+  enabled = true,
 }: {
   children: ReactNode;
   debug?: boolean;
   onStylesLoaded?: () => void;
+  enabled?: boolean;
 }) => {
   const { document: doc, window: win } = useFrame();
 
   useEffect(() => {
     if (!win || !doc) {
-      return () => {};
+      return;
+    }
+
+    if (!enabled) {
+      onStylesLoaded();
+
+      return;
     }
 
     let elements: { original: HTMLElement; mirror: HTMLElement }[] = [];
@@ -303,6 +311,7 @@ export type AutoFrameProps = {
   debug?: boolean;
   id?: string;
   onStylesLoaded?: () => void;
+  syncHostStyles?: boolean;
 };
 
 type AutoFrameContext = {
@@ -320,6 +329,7 @@ function AutoFrame({
   debug,
   id,
   onStylesLoaded,
+  syncHostStyles = true,
   ...props
 }: AutoFrameProps) {
   const [loaded, setLoaded] = useState(false);
@@ -351,7 +361,11 @@ function AutoFrame({
     >
       <autoFrameContext.Provider value={ctx}>
         {loaded && mountTarget && (
-          <CopyHostStyles debug={debug} onStylesLoaded={onStylesLoaded}>
+          <CopyHostStyles
+            debug={debug}
+            onStylesLoaded={onStylesLoaded}
+            enabled={syncHostStyles}
+          >
             {createPortal(children, mountTarget)}
           </CopyHostStyles>
         )}

diff --git a/packages/core/components/Puck/components/Preview/index.tsx b/packages/core/components/Puck/components/Preview/index.tsx
@@ -49,6 +49,7 @@ export const Preview = ({ id = "puck-preview" }: { id?: string }) => {
           onStylesLoaded={() => {
             setStatus("READY");
           }}
+          syncHostStyles={iframe.syncHostStyles}
         >
           <autoFrameContext.Consumer>
             {({ document }) => {

diff --git a/packages/core/components/Puck/index.tsx b/packages/core/components/Puck/index.tsx
@@ -76,9 +76,7 @@ export function Puck<UserConfig extends Config = Config>({
   headerTitle,
   headerPath,
   viewports = defaultViewports,
-  iframe = {
-    enabled: true,
-  },
+  iframe: _iframe,
   dnd,
   initialHistory,
 }: {
@@ -119,6 +117,12 @@ export function Puck<UserConfig extends Config = Config>({
     createReducer<UserConfig>({ config, record: historyStore.record, onAction })
   );
 
+  const iframe: IframeConfig = {
+    enabled: true,
+    syncHostStyles: true,
+    ..._iframe,
+  };
+
   const [initialAppState] = useState<AppState>(() => {
     const initial = { ...defaultAppState.ui, ...initialUi };
 

diff --git a/packages/core/types/IframeConfig.tsx b/packages/core/types/IframeConfig.tsx
@@ -1,3 +1,4 @@
 export type IframeConfig = {
   enabled?: boolean;
+  syncHostStyles?: boolean;
 };