/*--- waitForKeyElements(): A utility function, for Greasemonkey scripts, | |
that detects and handles AJAXed content. | |
Usage example: | |
waitForKeyElements ( | |
"div.comments" | |
, commentCallbackFunction | |
); | |
//--- Page-specific function to do what we want when the node is found. | |
function commentCallbackFunction (jNode) { | |
jNode.text ("This comment changed by waitForKeyElements()."); | |
} | |
IMPORTANT: This function requires your script to have loaded jQuery. | |
*/ | |
function waitForKeyElements ( | |
selectorTxt, /* Required: The jQuery selector string that | |
specifies the desired element(s). | |
*/ | |
actionFunction, /* Required: The code to run when elements are | |
found. It is passed a jNode to the matched | |
element. | |
*/ | |
bWaitOnce, /* Optional: If false, will continue to scan for | |
new elements even after the first match is | |
found. | |
*/ | |
iframeSelector /* Optional: If set, identifies the iframe to | |
search. | |
*/ | |
) { | |
var targetNodes, btargetsFound; | |
if (typeof iframeSelector == "undefined") | |
targetNodes = $(selectorTxt); | |
else | |
targetNodes = $(iframeSelector).contents () | |
.find (selectorTxt); | |
if (targetNodes && targetNodes.length > 0) { | |
btargetsFound = true; | |
/*--- Found target node(s). Go through each and act if they | |
are new. | |
*/ | |
targetNodes.each ( function () { | |
var jThis = $(this); | |
var alreadyFound = jThis.data ('alreadyFound') || false; | |
if (!alreadyFound) { | |
//--- Call the payload function. | |
var cancelFound = actionFunction (jThis); | |
if (cancelFound) | |
btargetsFound = false; | |
else | |
jThis.data ('alreadyFound', true); | |
} | |
} ); | |
} | |
else { | |
btargetsFound = false; | |
} | |
//--- Get the timer-control variable for this selector. | |
var controlObj = waitForKeyElements.controlObj || {}; | |
var controlKey = selectorTxt.replace (/[^\w]/g, "_"); | |
var timeControl = controlObj [controlKey]; | |
//--- Now set or clear the timer as appropriate. | |
if (btargetsFound && bWaitOnce && timeControl) { | |
//--- The only condition where we need to clear the timer. | |
clearInterval (timeControl); | |
delete controlObj [controlKey] | |
} | |
else { | |
//--- Set a timer, if needed. | |
if ( ! timeControl) { | |
timeControl = setInterval ( function () { | |
waitForKeyElements ( selectorTxt, | |
actionFunction, | |
bWaitOnce, | |
iframeSelector | |
); | |
}, | |
300 | |
); | |
controlObj [controlKey] = timeControl; | |
} | |
} | |
waitForKeyElements.controlObj = controlObj; | |
} |
This comment has been minimized.
This comment has been minimized.
(also, either way, deep gratitude for writing it!) |
This comment has been minimized.
This comment has been minimized.
Something's wrong with current Firefox, the script just stops on targetNodes.each(). Still works on SeaMonkey or older Firefox, so it's not just me or the page I'm working with, or is it? What I did was:
And looks like it works, but I'm not sure if I'm not making some type-casting crime or whatever ;) |
This comment has been minimized.
This comment has been minimized.
It fails to work when other javascript framework use $() as alias. So it's better to use jQuery() explicitly. |
This comment has been minimized.
This comment has been minimized.
Huh, I've not been getting email alerts for this? But GitHub seems to email just fine. |
This comment has been minimized.
This comment has been minimized.
@terabyte,
I'm not going to lawyer-up in any case. |
This comment has been minimized.
This comment has been minimized.
Hey Brock. Thanks for your help over on StackOverflow! GreasyFork has Github sync functionality.
I'd love to @include your script instead of a copy. If you aren't interested in creating a GreasyFork account let me know and I'll use the already posted script. Otherwise, point me to the GreasyFork version. Best! |
This comment has been minimized.
This comment has been minimized.
@GollyJer, Interesting, there appear to be at least 4 copies of waitForKeyElements on Greasy Fork: 3 out of 4 of them even credit me; I can die in peace! :D Anywho, I've no interest in creating a Greasy Fork account at this time. Use whichever version/method that works best for you. |
This comment has been minimized.
This comment has been minimized.
Seems the unacredited version is mine, fixed now, Cheers :) @GollyJer You could also import this script as a resource, like this : then read it with GM_getResourceText("waitForKeyElements ") and inject it on page or eval it in script. |
This comment has been minimized.
This comment has been minimized.
@BrockA - Apparently github is delivering notifications 11 months delayed? wtf... Anyways, many thanks for chiming in! I might still like to use it but I don't maintain disapproval plugin much these days, so not sure if I will ever get to it. Thanks for contributing to the hive mind just the same! =D |
This comment has been minimized.
This comment has been minimized.
Thanks for that @panayot-zhi Updated my script to point directly at the gist. |
This comment has been minimized.
This comment has been minimized.
@panayot-zhi - Even better yet, run the address through Git.io to get a shortened URL. |
This comment has been minimized.
This comment has been minimized.
A better link to the example is here: http://stackoverflow.com/questions/8281441/fire-greasemonkey-script-on-ajax-request/8283815#8283815 |
This comment has been minimized.
This comment has been minimized.
@hellonearthis And the problem itself is clearly described here: https://stackoverflow.com/questions/12897446/greasemonkey-wait-for-page-to-load-before-executing-code-techniques/12899331#12899331 |
This comment has been minimized.
This comment has been minimized.
Not sure if this has already been accomplished, but I couldn't find an example of this without the need for JQuery. I forked this and removed reliance on JQuery, though I had to hobble it by disabling the iframe search. Might help some though, and it works for my project. Thanks for your work @BrockA |
This comment has been minimized.
This comment has been minimized.
@mjblay What a crazy coincidence. I have been re-writing it as well within this past week to no longer rely on jQuery, and I also ended up removing the iframe feature until I had more time to re-write that part in vanillajs. I had published a gist a couple of days ago, but I removed it after encountering a few bugs. I checked out your Gist/Github account and couldn't find the fork. Are you planning on publishing it on Github? |
This comment has been minimized.
This comment has been minimized.
@mjblay, you're welcome. |
This comment has been minimized.
This comment has been minimized.
@insanid I inadvertently deleted it. I re-added the fork here: https://gist.github.com/mjblay/18d34d861e981b7785e407c3b443b99b. I haven't tested it thoroughly, but it seems to be working on a private site I maintain and use daily. |
This comment has been minimized.
This comment has been minimized.
Can this act within an iframe that is itself within an iframe? |
This comment has been minimized.
This comment has been minimized.
@Gallion, not directly but it can help. If you need to, open a question about that on some place like Stack Overflow and give details and a working test case or link to the target page. |
This comment has been minimized.
This comment has been minimized.
It's a very useful script but recently I met an issue. If waitForKeyElements already finds the element at the first run and the element disappears. The timer cannot be cleared since the element is not found anymore. |
This comment has been minimized.
This comment has been minimized.
@EliezerWu, Even when you set Anyway, post a "Minimal, Complete, and Verifiable example" if you want me to investigate this further. |
This comment has been minimized.
This comment has been minimized.
Hi =) thanks. |
This comment has been minimized.
This comment has been minimized.
@josepelupi, And anyone else who wants to use this commercially... Consider this free to use commercially until your install base exceeds twenty-thousand users. At which point, any fee would probably consist of a modest (3 digits or less) donation to EFF or similar. You could add a comment to your code: "Used by permission of github.com/BrockA until install base exceeds twenty-thousand users."
|
This comment has been minimized.
This comment has been minimized.
Many thanks for the reply. But i believe i was not clear enough in my question. I have no intention of creating scripts to sell. Im creating a script to share with my co-workers that automates parts of the activities we exercise while working (eg select options from a dropdown menu, fill out forms). So, my intention is to use waitForKeyElements to facilitate and allow the creation of dynamic buttons according to the elements that exist on the page. So, i would like to know if it is allowed to include your code in my greasemonkey script to use it , "indirectly", for the purpose of commercial use. thanks =)
|
This comment has been minimized.
This comment has been minimized.
@josepelupi, I did understand you. What you propose is still commercial use. If you get 20K people who use this, then let me know and we'll hash out a tiny donation, not to exceed $100, unless you cause me to incur costs in time or money. But, I might suggest that if your script does approach 20K users, then some intranet team has not done their job well. Until you get 20K people using the script, just comment in the code that you are legally covered. |
This comment has been minimized.
This comment has been minimized.
This is a great script! I have modified it with what I feel are some important improvements (not requiring jQuery, not using |
This comment has been minimized.
This comment has been minimized.
That's good, @CoeJoder. You might also consider one of the other forks (almost 100 on Gist alone) that uses |
This comment has been minimized.
This comment has been minimized.
Yes, there are some quite fancy implementations among the forks. I would personally avoid using |
This comment has been minimized.
This comment has been minimized.
I want to move the function into an object in a separate file that I call libraries.js. The object is called singleton as in
However, it throws an undefined error for waitForTargetElements at this line:
If I add waitForTargetElements to the list of parameters, then controlObj throws an undefined error. So my question is how do I decouple the scope so that the function can be placed in another file but can still be called? |
This comment has been minimized.
@BrockA : could we please get this under a BSD or Apache 2.0, or some other compatible license? We'd like to include it in https://github.com/palantir/stash-disapproval-plugin which is apache 2.0.