Islandora 2060 #82
Islandora 2060 #82
Conversation
…wer upon ajax call Why: * When a page containing an Openseadragon viewer also has a link that triggers an ajax call, clicking on that link causes the viewer to be duplicated. * The cause appears to be that an ajax call call triggers detach and attach functions for all Drupal.behaviors. * islandora_openseadragon’s detach function causes the old viewer to be disabled, but not removed or hidden, and then the subsequent attach function creates a new viewer. * I don’t understand the current logic of the attach and detach functions, but I assume they serve a purpose! This change addresses the need by: * Because I don’t understand the use case that the detach function was designed for, I chose to add a condition within that function which tests to see if the DOM element that was clicked is inside the Openseadragon viewer. Only then does the normal detach behavior run. * This prevents the detach function from disabling the viewer when the DOM element that triggered the ajax callback is elsewhere on the page. * I don’t know if this is the best solution, or even an acceptable one! Reference Links: * https://jira.duraspace.org/browse/ISLANDORA-2060
…ondition Why: * Nigel Banks commented: https://jira.duraspace.org/browse/ISLANDORA-2060?focusedCommentId=56918&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-56918 This change addresses the need by: * Changing detach condition to see if the context *is* the openseadragon viewer. Reference Links: * https://jira.duraspace.org/browse/ISLANDORA-2060
|
@patdunlavey @nigelgbanks this one is an improvement and we are close to code freeze. Please give this a push/search for reviewers in the committers group if you want to get this into code hopefully before the 15th! Good luck =) |
There was a problem hiding this comment.
This looks good to me, under default Islandora setup the detach function doesn't normally get called so no change in behaviour for 99% of users. In the case of users who have need to perform some Ajax calls on object pages that display the openseadragon viewer this improvement will prevent the issue described.
|
I'll merge after the standard 24 hours (assuming travis passes etc), unless someone else wants to chime in. |
|
That was quick! Travis is still runnig so make sure that passes first. Thanks to both, great response! |
|
Thanks for giving this priority, @nigelgbanks ! |
JIRA Ticket: ISLANDORA-2060
What does this Pull Request do?
The problem
When content is loaded via an ajax call on a page that has an Openseadragon viewer, the viewer replicates itself inside the
#islandora-openseadragondiv.The Drupal.behaviors.islandoraOpenSeadragon:detach function is being called during the ajax call, and this function is disabling but not removing the viewer. It also removes Drupal.IslandoraOpenSeadragonViewer[base].
After the detach event is done, a new attach event is triggered. When the attach function is called, it sees that there is no
Drupal.IslandoraOpenSeadragonViewer[base], so it adds a new one, thus duplicating the viewer.Desired outcome
Ajax calls within a page displaying an openseadragon viewer should not cause the viewer to be duplicated.
What's new?
Adds a condition to the Drupal.behaviors.IslandoraOpenSeadragon.detach function which checks to see if the context of the detach event is the openseadragon viewer. If so, it goes ahead with the detach. But if not, then it does not detach.
How should this be tested?
Additional Notes:
Interested parties
Tag @NigelBanks, @Islandora @7-x-1-x-committers