Developer Support
Deep Linking for Internal Dashboard Components (iframe)
2 min read
·
Last updated on Feb 14, 2023
Important:
We're currently having issues with this feature and are working hard to fix it. If you experience problems with deep linking then you can contact us.
An internal Dashboard component supports deep linking for its internal pages. Deep linking enables your app to update the content of your iframe without refreshing the whole iframe.
Your Dashboard component changes its state using JavaScript and AJAX methods. After the Dashboard component changes its state, it notifies the host website using the Wix.Dashboard.pushState() JavaScript method. This call will not reload your iframe. Wix will update the top window App-state part of the URL.
Your Dashboard component changes its state using JavaScript and AJAX methods. After the Dashboard component changes its state, it notifies the host website using the Wix.Dashboard.pushState() JavaScript method. This call will not reload your iframe. Wix will update the top window App-state part of the URL.
Example
If the browser is showing this URL: http://www.wix.com/my-account/site/<metaSite>/app/<appID>?queryParams
when you call the method: Dashboard.pushState(“AppState”) the browser URL will change to http://www.wix.com/my-account/site/<metaSiteId>/app/<appID>?queryParams&appState=<appState>
but your Dashboard iframe will not reload.
When there is a request to render your Dashboard iframe with an internal state, Wix will call your Dashboard endpoint with the internal state as part of the iframe’s URL in the app-state path variable. You should load your Dashboard component at the intended internal state.
when you call the method: Dashboard.pushState(“AppState”) the browser URL will change to http://www.wix.com/my-account/site/<metaSiteId>/app/<appID>?queryParams&appState=<appState>
but your Dashboard iframe will not reload.
When there is a request to render your Dashboard iframe with an internal state, Wix will call your Dashboard endpoint with the internal state as part of the iframe’s URL in the app-state path variable. You should load your Dashboard component at the intended internal state.
Example
When a user clicks on a link with a URL such as:
http://www.wix.com/my-account/app/<appID>/<AppInstanceID>/<appState>
We will load your Dashboard iframe using the URL:
http://www.yourApp.com/<appState>
http://www.wix.com/my-account/app/<appID>/<AppInstanceID>/<appState>
We will load your Dashboard iframe using the URL:
http://www.yourApp.com/<appState>
Note:
If you want to notify a user about something that happened in your app or an action they should take, you can direct them to your app in a specific Wix site. Use the following URL: https://www.wix.com/my-account/app/<appID>/<appInstanceID>/<appState>
Was this article helpful?
