Skip to content

Add SetExternalFrame function documentation #222

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.

Sign up for GitHub

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

Draft
Copilot wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Add SetExternalFrame function documentation #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95c7c50
Initial plan
Copilot Jul 4, 2025
31791fe
Add SetExternalFrame function documentation with complete structure a…
Copilot Jul 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/WebDocs/wwwroot/app/functions/SetExternalFrame/description.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<p>SetExternalFrame allows you to communicate with external iframe content by calling a function within the iframe and passing data from the current Drapo application context</p>
26 changes: 26 additions & 0 deletions src/WebDocs/wwwroot/app/functions/SetExternalFrame/parameters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[
{
"Name": "FrameID",
"Description": "The ID of the iframe element to communicate with",
"Types": [ "text", "mustache" ],
"Optional": false
},
{
"Name": "ExternalFunction",
"Description": "The name of the function to call within the iframe",
"Types": [ "text", "mustache" ],
"Optional": false
},
{
"Name": "DataKey",
"Description": "The data key containing the data to pass to the iframe function",
"Types": [ "text", "mustache" ],
"Optional": false
},
{
"Name": "IsClone",
"Description": "Whether to clone the data before passing it to the iframe (default: false)",
"Types": [ "boolean", "mustache" ],
"Optional": true
}
]
22 changes: 22 additions & 0 deletions src/WebDocs/wwwroot/app/functions/SetExternalFrame/samples/001/content.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
<head>
<script src="/drapo.js"></script>
<title>Function - SetExternalFrame</title>
</head>
<body>
<span>Function - SetExternalFrame</span>
<div>
<div d-dataKey="userData" d-dataType="object" d-dataProperty-name="John" d-dataProperty-email="john@example.com" d-dataProperty-age="30"></div>
<h3>User Data:</h3>
<p>Name: <span d-model="{{userData.name}}"></span></p>
<p>Email: <span d-model="{{userData.email}}"></span></p>
<p>Age: <span d-model="{{userData.age}}"></span></p>
<br />
<input type="button" value="Send Data to Frame" d-on-click="SetExternalFrame(targetFrame,receiveUserData,userData,false)" />
<br />
<br />
<iframe id="targetFrame" src="about:blank" style="width: 100%; height: 200px; border: 1px solid #ccc;"></iframe>
</div>
</body>
</html>
1 change: 1 addition & 0 deletions src/WebDocs/wwwroot/app/functions/SetExternalFrame/samples/001/description.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<p>Basic iframe communication example that sends user data to an external iframe</p>
23 changes: 23 additions & 0 deletions src/WebDocs/wwwroot/app/functions/SetExternalFrame/samples/002/content.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<script src="/drapo.js"></script>
<title>Function - SetExternalFrame with Cloning</title>
</head>
<body>
<span>Function - SetExternalFrame with Cloning</span>
<div>
<div d-dataKey="productList" d-dataType="array" d-dataValue="[{&quot;id&quot;: 1, &quot;name&quot;: &quot;Laptop&quot;, &quot;price&quot;: 999},{&quot;id&quot;: 2, &quot;name&quot;: &quot;Mouse&quot;, &quot;price&quot;: 25},{&quot;id&quot;: 3, &quot;name&quot;: &quot;Keyboard&quot;, &quot;price&quot;: 75}]"></div>
<h3>Product List:</h3>
<div d-for="product in productList">
<p>{{product.id}} - {{product.name}}: ${{product.price}}</p>
</div>
<br />
<input type="button" value="Send Products to Frame (Cloned)" d-on-click="SetExternalFrame(productFrame,displayProducts,productList,true)" />
<input type="button" value="Send Products to Frame (Reference)" d-on-click="SetExternalFrame(productFrame,displayProducts,productList,false)" />
<br />
<br />
<iframe id="productFrame" src="about:blank" style="width: 100%; height: 300px; border: 1px solid #ccc;"></iframe>
</div>
</body>
</html>
1 change: 1 addition & 0 deletions src/WebDocs/wwwroot/app/functions/SetExternalFrame/samples/002/description.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<p>Advanced example showing data cloning and bidirectional communication with an iframe</p>