Skip to content
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

Jump to bottom

Document how Overlay works behind the scenes #18660

Open
tsteur opened this issue Jan 19, 2022 · 0 comments
Open

Document how Overlay works behind the scenes #18660

tsteur opened this issue Jan 19, 2022 · 0 comments
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself.
Milestone
Priority Backlog ...

Comments

@tsteur
Copy link
Member

tsteur commented Jan 19, 2022

follows up from #18538

We will want to document on https://developer.matomo.org/piwik-in-depth how the Overlay feature works. I would have mentioned this as part of #18538 but better to have a separate issue for it.

It be great to document the flow like

  • Overlay is opened
  • The website is embedded as an iframe
    • The website within the frame calls ... to ...
    • This calls ... to ...

We want to document how the iframe and the parent frame communicates with each other.

We also want to cover, possibly as part of the flow, what some of these actions like notifyParentIframe and startOverlaySession do.
@tsteur tsteur added the c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. label Jan 19, 2022
@tsteur tsteur added this to the 4.8.0 milestone Jan 19, 2022
@tsteur tsteur modified the milestones: 4.8.0, 4.9.0 Feb 9, 2022
@tsteur tsteur modified the milestones: 4.9.0, 4.10.0 Mar 2, 2022
@mattab mattab added the c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. label Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself.
Projects
None yet
Milestone
Priority Backlog (Help wanted)
Development

No branches or pull requests
3 participants
@tsteur @mattab @justinvelluppillai