feat: Flow Builder iframe embed (POC) #217
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: "Build your flow" | ||
| description: "Design your flow and get the API calls for your exact use case" | ||
| mode: "custom" | ||
| "og:image": "/images/og/og-flow-builder.png" | ||
| --- | ||
|
|
||
| export const FlowBuilderEmbed = () => { | ||
| const [src, setSrc] = React.useState(null); | ||
|
|
||
| React.useEffect(() => { | ||
| const isDark = document.documentElement.classList.contains('dark'); | ||
| setSrc('https://grid-visualizer-opal.vercel.app/?embed=true&theme=' + (isDark ? 'dark' : 'light')); | ||
|
|
||
| let ignoreNextMutation = false; | ||
|
|
||
| const sendTheme = () => { | ||
| const t = document.documentElement.classList.contains('dark') ? 'dark' : 'light'; | ||
| const iframe = document.getElementById('flow-builder-iframe'); | ||
| if (iframe && iframe.contentWindow) { | ||
| iframe.contentWindow.postMessage({ type: 'theme-sync', theme: t }, '*'); | ||
| } | ||
| }; | ||
|
|
||
| const handleMessage = (e) => { | ||
| if (e.data && e.data.type === 'theme-request') { | ||
| sendTheme(); | ||
| return; | ||
| } | ||
| if (e.data && e.data.type === 'theme-sync') { | ||
| const isDark = document.documentElement.classList.contains('dark'); | ||
| const wantsDark = e.data.theme === 'dark'; | ||
| if (isDark !== wantsDark) { | ||
| ignoreNextMutation = true; | ||
| document.documentElement.classList.toggle('dark'); | ||
| } | ||
| } | ||
| }; | ||
|
Comment on lines
+25
to
+38
Contributor
There was a problem hiding this comment. Message handler doesn't validate Prompt To Fix With AIThis is a comment left during a code review.
Path: mintlify/flow-builder.mdx
Line: 25-38
Comment:
Message handler doesn't validate `e.origin` before processing messages, allowing any site to send theme-sync commands. Add origin check like `if (e.origin !== 'https://grid-visualizer-opal.vercel.app') return;`.
How can I resolve this? If you propose a fix, please make it concise. |
||
| window.addEventListener('message', handleMessage); | ||
|
|
||
| const obs = new MutationObserver(() => { | ||
| if (ignoreNextMutation) { ignoreNextMutation = false; return; } | ||
| sendTheme(); | ||
| }); | ||
| obs.observe(document.documentElement, { attributes: true, attributeFilter: ['class'] }); | ||
|
|
||
| return () => { | ||
| window.removeEventListener('message', handleMessage); | ||
| obs.disconnect(); | ||
| }; | ||
| }, []); | ||
|
Comment on lines
+11
to
+51
Contributor
There was a problem hiding this comment. Using Context Used: Context from Prompt To Fix With AIThis is a comment left during a code review.
Path: mintlify/flow-builder.mdx
Line: 11-51
Comment:
Using `React.useEffect` breaks Mintlify's acorn parser per CLAUDE.md style guide. Replace with initialization code that doesn't use `useEffect`.
**Context Used:** Context from `dashboard` - CLAUDE.md ([source](https://app.greptile.com/review/custom-context?memory=21abe025-35ab-4ae8-a4a1-0071c2ac3b98))
How can I resolve this? If you propose a fix, please make it concise.
Contributor
Author
There was a problem hiding this comment. this is wrong BTW, mintlify's own examples use useEffect https://www.mintlify.com/docs/customize/react-components#example-2 this was an old rule i added out of caution from a debugging session. i'll remove it |
||
|
|
||
| if (!src) return null; | ||
|
|
||
| return ( | ||
| <iframe | ||
| id="flow-builder-iframe" | ||
| src={src} | ||
| title="Grid Flow Builder" | ||
| allow="clipboard-write" | ||
| /> | ||
| ); | ||
| }; | ||
|
|
||
| <div id="flow-builder-container"> | ||
| <FlowBuilderEmbed /> | ||
| </div> | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using
'*'as targetOrigin inpostMessageallows any window to receive the message. Should validate and use specific origin like'https://grid-visualizer-opal.vercel.app'.Prompt To Fix With AI