Skip to content

Commit 3885857

Browse files
committed
Update README
1 parent 580d74d commit 3885857

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import Retool from 'react-retool';
2020
function App() {
2121
const sample = { name: 'Sample data' }
2222
return (
23-
<Retool
23+
<Retool
2424
url="https://retoolin.tryretool.com/embedded/public/f7607e1f-670a-4ebf-9a09-be54cf17181e"
2525
data={sample}
2626
/>
@@ -40,6 +40,8 @@ export default App;
4040

4141
`<Retool>` will accept an 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.
4242

43+
`<Retool>` also accepts optional `allow` and `sandbox` parameters 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.
44+
4345
### Example
4446

4547
Running `yarn start` will start an application with a basic Retool app embeded.

0 commit comments

Comments
 (0)