appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard

[Docs]: Provide a document on how to share the data from parent page to embedded Appsmith page

Open abhvsn opened this issue 3 years ago • 9 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues

Documentation Link

No response

Describe the problem

When users embeds the Appsmith in their web pages we can share the data from parent page to Appsmith page through query params. But we don't have step-by-step doc on how user can do this.

Describe the improvement

A step-by-step guide on how to implement this will be helpful.

abhvsn avatar Dec 23 '21 09:12 abhvsn

@abhvsn / @rimildeyjsr - could you please provide more information on what is needed? We do have a how-to guide on sharing data across pages.

jnikhila avatar May 25 '22 09:05 jnikhila

@somangshu I don't have much context here can someone from pod-app-viewers help to create this doc?

abhvsn avatar Jun 15 '22 06:06 abhvsn

Sure @abhvsn

@jnikhila here we are talking about the communication between the embedded page and appsmith platform. I.E how does one trigger an event (with some data) in appsmith from the page that is embedded in an appsmith iFrame widget! To resolve this we are using window.postMessage() API. We have a sample app here on release that shows how this works, please check it out and let me know when you have more questions.

somangshu avatar Jun 17 '22 10:06 somangshu

@somangshu - Will the doc created for #14794 solve this?

jnikhila avatar Jun 24 '22 11:06 jnikhila

@jnikhila the pointers do cover it, Let me know if you want me to review the actual doc also, I am not able to find it right now

somangshu avatar Jun 28 '22 07:06 somangshu

@somangshu - I'll share the doc, once it's available. I think, we should be able to pick it up in the upcoming sprint.

jnikhila avatar Jun 28 '22 07:06 jnikhila

@somangshu - Do you have a release date for this?

jnikhila avatar Jun 29 '22 09:06 jnikhila

@jnikhila I think I initial understanding of this issue is skewed. Apologies for the same! Here is what I have understood now

OP asks for a way to communicate with the appsmith app that is embedded in their application.

We don't have postMessage API that can help here. The initial sample app which I provided caters to another use case all together. My understanding right now is that if the parent app (where appsmith app is embedded) needs to communicate with the embedded appsmith app, they can use either postMessage (not sure how possible if this) or use the query params as explained above (For which we need to detail the doc).

For a bit more context, we have recently also published a new feature #7241, which provides a way for the parent app (where appsmith app is embedded) to receive a message from the appsmith app using the postMessage API.

cc @rimildeyjsr @dilippitchika Do you guys think I am going in the right direction now, Please advise!

somangshu avatar Jun 30 '22 05:06 somangshu

@rimildeyjsr is this window.postmessage() ? Can you close this if that's the case, as we already have a ticket for that.

Pranay105 avatar Dec 07 '22 09:12 Pranay105

Completed via https://github.com/appsmithorg/appsmith-docs/issues/734

danciaclara avatar Feb 08 '23 09:02 danciaclara