Example instance hosted here. Source code available here.
Usage
// Request a config
const $config = new $Config(
'STORAGE_KEY',
{
get: (_, configs) => ({data: 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().data;
// 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
- [DefaultStyle*] Instructions for customizing the UI's appearance
- [object*] CSS to apply to the UI's root element