$Config

Greasy Fork is available in English.

$Config

Allows users to configure scripts

当前为 2024-11-20 提交的版本，查看最新版本。

此脚本不应直接安装。它是供其他脚本使用的外部库，要使用该库请加入元指令 // @require https://update.greasyfork.icu/scripts/446506/1487938/%24Config.js

提问、发表评价或者举报此脚本。

作者: ctl2
版本: 0.0.1.20241120172422
创建于: 2022-06-15
更新于: 2024-11-20
大小: 283.2 KB
许可证: 暂无

Example instance hosted here. Source code available here.

Usage

// Request a config

const $config = new $Config(
    'Example Title',
    'STORAGE_KEY',
    {
        'children': [
            {'label': 'node0'},
            {'label': 'node1'},
            {'label': 'node2'}
        ]
    },
    ([node0, node1, node2]) => ({
        value0: node0.value,
        value1: node1.value,
        value2: node2.value,
    }),
);

// 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 {value0, value1, value2} = $config.get();

    // Use the config...
}

useConfig();

// Set up config editing

const button = document.createElement('button');

button.addEventListener('click', async () => {
    await $config.edit();

    useConfig();
});

Constructor arguments (* = optional):

[string] An identifier used to store data
[Root] A schema for user config data
[ParentCallback] The function used to convert tree data into a convenient format for your script
[string] The config modal's title
[DefaultStyle*] Instructions for customizing the UI's appearance
[object*] CSS to apply to the UI's root element

See the following scripts for practical examples: