$Config

Allows users to configure scripts

Detta skript bör inte installeras direkt. Det är ett bibliotek för andra skript att inkludera med meta-direktivet // @require https://update.greasyfork.org/scripts/446506/1683593/%24Config.js

You will need to install an extension such as Tampermonkey, Greasemonkey or Violentmonkey to install this script.

You will need to install an extension such as Tampermonkey to install this script.

You will need to install an extension such as Tampermonkey or Violentmonkey to install this script.

You will need to install an extension such as Tampermonkey or Userscripts to install this script.

You will need to install an extension such as Tampermonkey to install this script.

You will need to install a user script manager extension to install this script.

(I already have a user script manager, let me install it!)

You will need to install an extension such as Stylus to install this style.

You will need to install an extension such as Stylus to install this style.

You will need to install an extension such as Stylus to install this style.

You will need to install a user style manager extension to install this style.

You will need to install a user style manager extension to install this style.

You will need to install a user style manager extension to install this style.

(I already have a user style manager, let me install it!)

Upphovsman
ctl2
Version
0.0.1.20251025124509
Skapad
2022-06-15
Uppdaterad
2025-10-25
Size
338 KB
Licens
N/A

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
  1. [string] An identifier used to store data
  2. [Root] A schema for user config data
  3. {
     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,
    }
The third argument and each of its properties are optional

Examples