-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Flaviu Tamas
committed
Nov 29, 2023
1 parent
159180f
commit 2abf950
Showing
3 changed files
with
59 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,48 @@ | ||
import * as React from 'react'; | ||
|
||
export interface RetoolProps<T> { | ||
/** | ||
* url prop pointing to an embedded Retool application. You can generate this URL in the editor | ||
* mode of a Retool app by clicking "Share" then "Public". | ||
*/ | ||
url: string | ||
/** | ||
* an optional data object, which is made available to the embedded application. When an embedded | ||
* Retool application runs a Parent Window Query, <Retool> will check if data contains a key | ||
* matching the Parent Window Query's selector, and if so, return that value to the query. | ||
*/ | ||
data?: Record<string, T> | ||
/** | ||
* optional height and width props which will be used for the dimensions of the embedded window. | ||
*/ | ||
height?: string | number | ||
/** | ||
* optional height and width props which will be used for the dimensions of the embedded window. | ||
*/ | ||
width?: string | number | ||
/** | ||
* optional onData callback that will be called with the data of an event that is sent from the | ||
* embedded Retool app. These events can be sent from a JavaScript query inside of Retool by using | ||
* the parent.postMessage() syntax. | ||
*/ | ||
onData?: (data: T) => void | ||
/** | ||
* optional sandbox parameter to configure permissions of the iframe used to embed the Retool | ||
* app. allow-scripts and allow-same-origin are required in order to run Retool, so if sandbox is | ||
* specified, allow-scripts and allow-same-origin will always be appended to ensure the Retool app | ||
* works. | ||
*/ | ||
sandbox?: boolean | string | ||
/** | ||
* optional allow parameter to configure permissions of the iframe used to embed the Retool app. | ||
*/ | ||
allow?: string | ||
/** | ||
* optional styling prop object that can be used to pass in styles to the iframe component. | ||
*/ | ||
styling?: React.CSSProperties | ||
} | ||
|
||
declare const Retool: <T> (props: RetoolProps<T>) => React.ReactElement | ||
|
||
export default Retool |
Empty file.