-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: ideas for plugin wrappers [LIBS-397]
- Loading branch information
Showing
5 changed files
with
155 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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 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,53 @@ | ||
| import postRobot from 'post-robot' | ||
| import React, { useEffect, useRef, useState } from 'react' | ||
|
|
||
| export const PluginSender = ({ | ||
| pluginSource, | ||
| ...propsToPass | ||
| }: { | ||
| pluginSource: string | ||
| propsToPass: any | ||
| }): JSX.Element => { | ||
| const iframeRef = useRef<any>() | ||
|
|
||
| const [missingProps, setMissingProps] = useState<any[] | null>(null) | ||
|
|
||
| useEffect(() => { | ||
| if (iframeRef?.current) { | ||
| const iframeProps = { ...propsToPass, setMissingProps } | ||
| const listener = postRobot.on( | ||
| 'getPropsFromParent', | ||
| // listen for messages coming only from the iframe rendered by this component | ||
| { window: iframeRef.current.contentWindow }, | ||
| (): any => { | ||
| return iframeProps | ||
| } | ||
| ) | ||
|
|
||
| return () => listener.cancel() | ||
| } | ||
| }, [propsToPass]) | ||
|
|
||
| if (missingProps && missingProps?.length > 0) { | ||
| return ( | ||
| <p>{`Plugin could not load because required props are missing: ${missingProps.join()}`}</p> | ||
| ) | ||
| } | ||
|
|
||
| return ( | ||
| <div> | ||
| {pluginSource ? ( | ||
| <iframe | ||
| ref={iframeRef} | ||
| src={pluginSource} | ||
| style={{ | ||
| width: '100%', | ||
| height: '100%', | ||
| border: 'none', | ||
| }} | ||
| hidden={missingProps === null} | ||
| ></iframe> | ||
| ) : null} | ||
| </div> | ||
| ) | ||
| } |
This file contains 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,43 @@ | ||
| import postRobot from 'post-robot' | ||
| import { useEffect, useState } from 'react' | ||
|
|
||
| export const PluginWrapper = ({ | ||
| requiredProps, | ||
| children, | ||
| }: { | ||
| requiredProps: [string] | ||
| children: any | ||
| }): any => { | ||
| const [propsFromParent, setPropsFromParent] = useState<any>() | ||
|
|
||
| const receivePropsFromParent = (event: any) => { | ||
| const { data: receivedProps } = event | ||
| const { setMissingProps, ...explictlyPassedProps } = receivedProps | ||
|
|
||
| setPropsFromParent(explictlyPassedProps) | ||
|
|
||
| // check for required props | ||
| const missingProps = requiredProps?.filter( | ||
| (prop) => !receivedProps[prop] | ||
| ) | ||
| if (missingProps && missingProps.length > 0) { | ||
| setMissingProps(missingProps) | ||
| console.error( | ||
| `The following required props were not provided: ${missingProps.join( | ||
| ',' | ||
| )}` | ||
| ) | ||
| } else { | ||
| setMissingProps([]) | ||
| } | ||
| } | ||
|
|
||
| useEffect(() => { | ||
| postRobot | ||
| .send(window.top, 'getPropsFromParent') | ||
| .then(receivePropsFromParent) | ||
| .catch((err: Error) => console.error(err)) | ||
| }) | ||
|
|
||
| return children({ ...propsFromParent }) | ||
| } |
This file contains 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 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