Skip to content

Add the drapo function called 'GetExternalFrameMessage' #232

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 the drapo function called 'GetExternalFrameMessage' #232

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
75a0536
Initial plan
Copilot Jul 4, 2025
0ee361c
Changes before error encountered
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/GetExternalFrameMessage/description.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<p>The GetExternalFrameMessage function is used to retrieve data from an external iframe using the postMessage API. This function sends a message to the specified iframe and waits for a response, then stores the received data in the specified data key. It enables secure communication between the parent window and child iframe content.</p>
27 changes: 27 additions & 0 deletions src/WebDocs/wwwroot/app/functions/GetExternalFrameMessage/parameters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[
{
"Name": "frameID",
"Description": "The ID of the iframe element to communicate with",
"Types": [ "text", "mustache" ],
"Optional": false
},
{
"Name": "externalFunction",
"Description": "The tag or function name to be used in the message for identification purposes",
"Types": [ "text", "mustache" ],
"Optional": false
},
{
"Name": "dataKey",
"Description": "The data key where the response data will be stored",
"Types": [ "datakey" ],
"Optional": false
},
{
"Name": "isClone",
"Description": "Whether to clone the received data before storing it",
"Types": [ "boolean" ],
"Optional": true,
"DefaultValue": "false"
}
]
34 changes: 34 additions & 0 deletions src/WebDocs/wwwroot/app/functions/GetExternalFrameMessage/samples/001/content.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<div d-dataKey="externalData" d-dataType="array"></div>
<div d-dataKey="responseMessage" d-dataType="value"></div>

<h3>GetExternalFrameMessage Example</h3>
<p>This example demonstrates how to get data from an external iframe using postMessage communication.</p>

<div style="margin: 10px 0;">
<input type="button" value="Get Data from Frame" d-on-click="GetExternalFrameMessage(sampleFrame,GetUserData,externalData,true)" />
<span d-model="{{responseMessage}}"></span>
</div>

<h4>Received Data:</h4>
<div d-for="item in externalData">
<div style="border: 1px solid #ccc; padding: 5px; margin: 2px;">
<strong>{{item.name}}</strong> - {{item.email}}
</div>
</div>

<h4>Sample iframe (simulated):</h4>
<iframe id="sampleFrame"
src="data:text/html,<html><body><script>
window.addEventListener('message', function(event) {
if (event.data && event.data.Action === 'get' && event.data.Tag === 'GetUserData') {
const sampleData = [
{name: 'John Doe', email: 'john@example.com'},
{name: 'Jane Smith', email: 'jane@example.com'}
];
event.source.postMessage({_data: sampleData}, '*');
}
});
</script>
<p>Sample iframe content - this would normally be an external page</p>
</body></html>"
style="width: 100%; height: 100px; border: 1px solid #ddd;"></iframe>
1 change: 1 addition & 0 deletions src/WebDocs/wwwroot/app/functions/GetExternalFrameMessage/samples/001/description.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<p>A sample that demonstrates GetExternalFrameMessage to retrieve data from an iframe. The example shows how to communicate with an external frame to get user data and store it in a data key.</p>