Allows users to configure scripts
This script should not be not be installed directly. It is a library for other scripts to include with the meta directive // @require https://update.greasyfork.org/scripts/446506/1683593/%24Config.js
Example instance hosted here. Source code available here.Usage
// @require https://update.greasyfork.org/scripts/446506/1586074/%24Config.js
// @grant GM.setValue
// @grant GM.getValue
// @grant GM.deleteValue
// Define a config
const $config = new $Config(
'STORAGE_KEY',
{
get: (_, configs) => Object.assign(...configs),
children: [
{label: 'a', value: 0, get: ({value: a}) => ({a})},
{label: 'b', value: 1, get: ({value: b}) => ({b})},
{label: 'c', value: 2, get: ({value: c}) => ({c})}
]
},
);
// Await config load & handle problems
try {
await $config.ready;
} catch (error) {
if (!$config.reset) {
// There's a problem with the arguments passed to the $Config constructor
throw error;
}
// There's a problem with the user's data (could be from manual editing or a script update)
if (!window.confirm(`${error.message}\n\nWould you like to erase your data?`)) {
return;
}
$config.reset();
}
// Apply the user's config
function useConfig() {
const {a, b, c} = $config.get();
// ...
}
useConfig();
// Set up config editing
const button = document.createElement('button');
button.addEventListener('click', async () => {
await $config.edit();
useConfig();
});
Constructor arguments
The third argument and each of its properties are optional
defaultStyle: [DefaultStyle] Instructions for customizing the UI's appearance,
outerStyle: [object] CSS to apply to the UI's root element,
patches: [array<function>] Patches to update old config objects,
}
