-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add type definitions #54
Open
flaviut
wants to merge
1
commit into
tryretool:main
Choose a base branch
from
oneapp-oss:flaviu/retool-type-def
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
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.
the build script could be edited to rename these to
index.*
, (although that'd have no actual effect) but without these lines, my project depending on this wouldn't build.