rybak/userscript-libs

Libraries for use by developers in their userscripts

Userscript libraries

These are libraries for use in userscripts by developers.

How to use a library

Using waitForElement.js as an example – replace the filename in instructions with the library you would like to use.

Add a @require entry to metadata of the userscript:

// @require https://github.com/rybak/userscript-libs/raw/<commit>/waitForElement.js

Replace the <commit> placeholder with the hash of the commit that you want to use.

If you want to publish the userscript on Greasy Fork, you'll have to follow their policy on external scripts. This can be done using the JSDelivr CDN or other content delivery networks approved by Greasy Fork. Greasy Fork (rightly) doesn't allow using a branch or a tag.

// @require https://cdn.jsdelivr.net/gh/rybak/userscript-libs@<commit>/waitForElement.js

Libraries

waitForElement

Provides a way for userscripts to wait for native HTML or SVG elements to be loaded, before performing some operation on them. Function waitForElement takes a selector as a parameter and returns a Promise. The returned Promise gets resolved with an Element corresponding to the given selector, when the element appears in the document. Usage:

waitForElement('#targetId').then(target => {
	// extract information from `target`:
	const text = target.innerText;
	// add your own elements to `target`:
	target.append("Hello, world!");
});

userscript-libs's Issues

Library for setting favicons

There are six userscripts that I maintain that change favicons in almost identical ways:

• https://github.com/rybak/github-pr-avatars-tab-icons/blob/257c2ff0b1c5cb927572671a243252ad0626cc32/github-pull-request-avatars.user.js#L105-L114
• https://github.com/rybak/subreddit-tab-icons/blob/7de11c3533e12de3ad80083b50817bfbee41f5aa/subreddit-tab-icons.user.js#L123-L141
• https://github.com/rybak/twitter-old-name-and-logo-userscript/blob/e0dfdbd234547ae6a8157ec6e979a81e66db7328/twitter-old-name-and-logo.user.js#L153-L168
• https://github.com/rybak/atlassian-tweaks/blob/515f818af462cba15ef009a0a0be6f793cbdb64d/bitbucket-pull-request-avatars.user.js#L65-L74
• https://github.com/rybak/atlassian-tweaks/blob/515f818af462cba15ef009a0a0be6f793cbdb64d/jira-project-avatar-as-favicon.user.js#L62-L66
• https://github.com/rybak/atlassian-tweaks/blob/515f818af462cba15ef009a0a0be6f793cbdb64d/confluence-space-avatar-favicons.user.js#L24-L39

Making a library for this might be useful.