obsidian-dev-utils 3.44.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/dist/lib/obsidian/Plugin/ValueComponent.cjs +92 -0
- package/dist/lib/obsidian/Plugin/ValueComponent.d.ts +97 -0
- package/dist/lib/obsidian/Plugin/index.cjs +4 -4
- package/dist/lib/obsidian/Plugin/index.d.ts +1 -1
- package/package.json +1 -1
- package/dist/lib/obsidian/Plugin/UIComponent.cjs +0 -81
- package/dist/lib/obsidian/Plugin/UIComponent.d.ts +0 -88
package/CHANGELOG.md
CHANGED
@@ -0,0 +1,92 @@
|
|
1
|
+
/*
|
2
|
+
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
3
|
+
if you want to view the source, please visit the github repository of this plugin
|
4
|
+
*/
|
5
|
+
|
6
|
+
(function patchRequireEsmDefault(){const __require=require;require=Object.assign(id=>{const module=__require(id);return module.__esModule&&module.default?module.default:module},__require)})()
|
7
|
+
|
8
|
+
"use strict";
|
9
|
+
var __defProp = Object.defineProperty;
|
10
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
11
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
12
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
13
|
+
var __export = (target, all) => {
|
14
|
+
for (var name in all)
|
15
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
16
|
+
};
|
17
|
+
var __copyProps = (to, from, except, desc) => {
|
18
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
19
|
+
for (let key of __getOwnPropNames(from))
|
20
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
21
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
22
|
+
}
|
23
|
+
return to;
|
24
|
+
};
|
25
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
26
|
+
var ValueComponent_exports = {};
|
27
|
+
__export(ValueComponent_exports, {
|
28
|
+
bindValueComponent: () => bindValueComponent
|
29
|
+
});
|
30
|
+
module.exports = __toCommonJS(ValueComponent_exports);
|
31
|
+
var import_obsidian = require('obsidian');
|
32
|
+
function bindValueComponent(plugin, valueComponent, property, options) {
|
33
|
+
const DEFAULT_OPTIONS = {
|
34
|
+
autoSave: true,
|
35
|
+
pluginSettingsToComponentValueConverter: (value) => value,
|
36
|
+
componentToPluginSettingsValueConverter: (value) => value
|
37
|
+
};
|
38
|
+
const optionsExt = { ...DEFAULT_OPTIONS, ...options };
|
39
|
+
const pluginExt = plugin;
|
40
|
+
const uiComponentExt = valueComponent;
|
41
|
+
const pluginSettingsFn = () => optionsExt.pluginSettings ?? pluginExt.settingsCopy;
|
42
|
+
uiComponentExt.setValue(optionsExt.pluginSettingsToComponentValueConverter(pluginSettingsFn()[property])).onChange(async (uiValue) => {
|
43
|
+
if (!validateComponent(uiValue)) {
|
44
|
+
return;
|
45
|
+
}
|
46
|
+
const pluginSettings = pluginSettingsFn();
|
47
|
+
pluginSettings[property] = optionsExt.componentToPluginSettingsValueConverter(uiValue);
|
48
|
+
if (optionsExt.autoSave) {
|
49
|
+
await pluginExt.saveSettings(pluginSettings);
|
50
|
+
}
|
51
|
+
await optionsExt.onChanged?.();
|
52
|
+
});
|
53
|
+
const validatorElement = getValidatorElement(valueComponent);
|
54
|
+
if (validatorElement) {
|
55
|
+
validatorElement.addEventListener("focus", () => validateComponent());
|
56
|
+
validatorElement.addEventListener("blur", () => validateComponent());
|
57
|
+
}
|
58
|
+
return valueComponent;
|
59
|
+
function validateComponent(uiValue) {
|
60
|
+
if (!optionsExt.valueValidator) {
|
61
|
+
return true;
|
62
|
+
}
|
63
|
+
uiValue ??= uiComponentExt.getValue();
|
64
|
+
const errorMessage = optionsExt.valueValidator(uiValue);
|
65
|
+
const validatorElement2 = getValidatorElement(valueComponent);
|
66
|
+
if (validatorElement2) {
|
67
|
+
validatorElement2.setCustomValidity(errorMessage ?? "");
|
68
|
+
validatorElement2.reportValidity();
|
69
|
+
}
|
70
|
+
return !errorMessage;
|
71
|
+
}
|
72
|
+
}
|
73
|
+
function getValidatorElement(valueComponent) {
|
74
|
+
if (valueComponent instanceof import_obsidian.DropdownComponent) {
|
75
|
+
return valueComponent.selectEl;
|
76
|
+
}
|
77
|
+
if (valueComponent instanceof import_obsidian.SliderComponent) {
|
78
|
+
return valueComponent.sliderEl;
|
79
|
+
}
|
80
|
+
if (valueComponent instanceof import_obsidian.TextAreaComponent) {
|
81
|
+
return valueComponent.inputEl;
|
82
|
+
}
|
83
|
+
if (valueComponent instanceof import_obsidian.TextComponent) {
|
84
|
+
return valueComponent.inputEl;
|
85
|
+
}
|
86
|
+
return null;
|
87
|
+
}
|
88
|
+
// Annotate the CommonJS export names for ESM import in node:
|
89
|
+
0 && (module.exports = {
|
90
|
+
bindValueComponent
|
91
|
+
});
|
92
|
+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/obsidian/Plugin/ValueComponent.ts"],
  "sourcesContent": ["import {\n  DropdownComponent,\n  SliderComponent,\n  TextAreaComponent,\n  TextComponent\n} from 'obsidian';\n\nimport type { KeysMatching } from '../../@types.ts';\nimport type { MaybePromise } from '../../Async.ts';\nimport type { PluginBase } from './PluginBase.ts';\n\n/**\n * A ValueComponent that can be bound to a plugin setting.\n */\nexport interface ValueComponent<UIValue> {\n  /**\n   * Gets the value of the component.\n   *\n   * @returns The value of the component.\n   */\n  getValue(): UIValue;\n\n  /**\n   * Sets the value of the component.\n   * @param value - The value to set on the component.\n   */\n  setValue(value: UIValue): this;\n\n  /**\n   * Sets a callback function to be called when the value of the component changes.\n   * @param callback - A callback function that is called when the value of the component changes.\n   */\n  onChange(callback: (newValue: UIValue) => Promise<void>): this;\n}\n\n/**\n * A HTML element that can be validated.\n */\ninterface ValidatorElement extends HTMLElement {\n  /**\n   * Sets a custom error message on the element.\n   * @param error - The error message to set on the element.\n   */\n  setCustomValidity(error: string): void;\n\n  /**\n   * Reports the validity of the element.\n   */\n  reportValidity(): boolean;\n}\n\n/**\n * Options for binding a value component to a plugin setting.\n */\ninterface BindValueComponentOptions<PluginSettings, UIValue> {\n  /**\n   * If true, saves the plugin settings automatically after the component value changes. Default is `true`.\n   */\n  autoSave?: boolean;\n\n  /**\n   * The plugin settings object to bind the component to. Default is the plugin's current settings.\n   */\n  pluginSettings?: PluginSettings;\n\n  /**\n   * Validates the UI value before setting it on the plugin settings.\n   * @param uiValue - The value of the UI component.\n   * @returns An error message if the value is invalid, or `null` if it is valid.\n   */\n  valueValidator?: (uiValue: UIValue) => string | null;\n\n  /**\n   * A callback function that is called when the value of the component changes.\n   */\n  onChanged?: () => MaybePromise<void>;\n}\n\n/**\n * Extended options for binding a value component to a plugin setting.\n */\ninterface BindValueComponentOptionsExtended<PluginSettings, UIValue, Property extends keyof PluginSettings> extends BindValueComponentOptions<PluginSettings, UIValue> {\n  /**\n   * Converts the plugin settings value to the value used by the UI component.\n   * @param pluginSettingsValue - The value of the property in the plugin settings.\n   * @returns The value to set on the UI component.\n   */\n  pluginSettingsToComponentValueConverter: (pluginSettingsValue: PluginSettings[Property]) => UIValue;\n\n  /**\n   * Converts the UI component's value back to the plugin settings value.\n   * @param uiValue - The value of the UI component.\n   * @returns The value to set on the plugin settings.\n   */\n  componentToPluginSettingsValueConverter: (uiValue: UIValue) => PluginSettings[Property];\n}\n\n/**\n * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n *\n * @typeParam Plugin - The type of the plugin that extends `PluginBase`.\n * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.\n * @typeParam Property - The key of the plugin setting that the component is bound to.\n * @typeParam UIValue - The inferred type based on the UI component's type.\n * @typeParam PluginSettings - The inferred type of the plugin settings object.\n *\n * @param plugin - The plugin.\n * @param valueComponent - The component that will display and interact with the setting value.\n * @param property - The property key in `PluginSettings` to bind to the UI component.\n * @param options - Configuration options.\n * @returns The `ValueComponent` instance that was bound to the property.\n */\nexport function bindValueComponent<\n  Plugin extends PluginBase<object>,\n  TValueComponent extends ValueComponent<unknown>,\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters\n  Property extends KeysMatching<PluginSettings, UIValue>,\n  UIValue = TValueComponent extends ValueComponent<infer P> ? P : never,\n  PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never\n>(\n  plugin: Plugin,\n  valueComponent: TValueComponent,\n  property: Property,\n  options?: BindValueComponentOptions<PluginSettings, UIValue>\n): TValueComponent;\n\n/**\n * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n *\n * @typeParam Plugin - The type of the plugin that extends `PluginBase`.\n * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.\n * @typeParam Property - The key of the plugin setting that the component is bound to.\n * @typeParam UIValue - The inferred type based on the value component's type.\n * @typeParam PluginSettings - The inferred type of the plugin settings object.\n *\n * @param plugin - The plugin.\n * @param valueComponent - The component that will display and interact with the setting value.\n * @param property - The property key in `PluginSettings` to bind to the UI component.\n * @param options - Configuration options.\n * @returns The `ValueComponent` instance that was bound to the property.\n */\nexport function bindValueComponent<\n  Plugin extends PluginBase<object>,\n  TValueComponent extends ValueComponent<unknown>,\n  Property extends keyof PluginSettings,\n  UIValue = TValueComponent extends ValueComponent<infer P> ? P : never,\n  PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never\n>(\n  plugin: Plugin,\n  valueComponent: TValueComponent,\n  property: Property,\n  options: BindValueComponentOptionsExtended<PluginSettings, UIValue, Property>\n): TValueComponent;\n\n/**\n * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n *\n * @typeParam Plugin - The type of the plugin that extends `PluginBase`.\n * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.\n * @typeParam Property - The key of the plugin setting that the component is bound to.\n * @typeParam UIValue - The inferred type based on the value component's type.\n * @typeParam PluginSettings - The inferred type of the plugin settings object.\n *\n * @param plugin - The plugin.\n * @param valueComponent - The component that will display and interact with the setting value.\n * @param property - The property key in `PluginSettings` to bind to the UI component.\n * @param options - Configuration options.\n * @returns The `ValueComponent` instance that was bound to the property.\n */\nexport function bindValueComponent<\n  Plugin extends PluginBase<object>,\n  TValueComponent extends ValueComponent<unknown>,\n  Property extends keyof PluginSettings,\n  UIValue = TValueComponent extends ValueComponent<infer P> ? P : never,\n  PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never\n>(\n  plugin: Plugin,\n  valueComponent: TValueComponent,\n  property: Property,\n  options?: BindValueComponentOptions<PluginSettings, UIValue>\n): TValueComponent {\n  type PropertyType = PluginSettings[Property];\n  const DEFAULT_OPTIONS: BindValueComponentOptionsExtended<PluginSettings, UIValue, Property> = {\n    autoSave: true,\n    pluginSettingsToComponentValueConverter: (value): UIValue => value as UIValue,\n    componentToPluginSettingsValueConverter: (value): PropertyType => value as PropertyType\n  };\n\n  const optionsExt: BindValueComponentOptionsExtended<PluginSettings, UIValue, Property> = { ...DEFAULT_OPTIONS, ...options };\n  const pluginExt = plugin as unknown as PluginBase<PluginSettings>;\n  const uiComponentExt = valueComponent as ValueComponent<UIValue>;\n  const pluginSettingsFn = (): PluginSettings => optionsExt.pluginSettings ?? pluginExt.settingsCopy;\n  uiComponentExt\n    .setValue(optionsExt.pluginSettingsToComponentValueConverter(pluginSettingsFn()[property]))\n    .onChange(async (uiValue) => {\n      if (!validateComponent(uiValue)) {\n        return;\n      }\n      const pluginSettings = pluginSettingsFn();\n      pluginSettings[property] = optionsExt.componentToPluginSettingsValueConverter(uiValue);\n      if (optionsExt.autoSave) {\n        await pluginExt.saveSettings(pluginSettings);\n      }\n\n      await optionsExt.onChanged?.();\n    });\n\n  const validatorElement = getValidatorElement(valueComponent);\n  if (validatorElement) {\n    validatorElement.addEventListener('focus', () => validateComponent());\n    validatorElement.addEventListener('blur', () => validateComponent());\n  }\n\n  return valueComponent;\n\n  function validateComponent(uiValue?: UIValue): boolean {\n    if (!optionsExt.valueValidator) {\n      return true;\n    }\n    uiValue ??= uiComponentExt.getValue();\n    const errorMessage = optionsExt.valueValidator(uiValue);\n    const validatorElement = getValidatorElement(valueComponent);\n    if (validatorElement) {\n      validatorElement.setCustomValidity(errorMessage ?? '');\n      validatorElement.reportValidity();\n    }\n\n    return !errorMessage;\n  }\n}\n\n/**\n * Gets the validator element from a value component if it exists.\n *\n * @param valueComponent - The value component to get the validator element from.\n * @returns The validator element if it exists, or `null` if it does not.\n */\nfunction getValidatorElement(valueComponent: ValueComponent<unknown>): ValidatorElement | null {\n  if (valueComponent instanceof DropdownComponent) {\n    return valueComponent.selectEl;\n  }\n\n  if (valueComponent instanceof SliderComponent) {\n    return valueComponent.sliderEl;\n  }\n\n  if (valueComponent instanceof TextAreaComponent) {\n    return valueComponent.inputEl;\n  }\n\n  if (valueComponent instanceof TextComponent) {\n    return valueComponent.inputEl;\n  }\n\n  return null;\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAKO;AAoKA,SAAS,mBAOd,QACA,gBACA,UACA,SACiB;AAEjB,QAAM,kBAAwF;AAAA,IAC5F,UAAU;AAAA,IACV,yCAAyC,CAAC,UAAmB;AAAA,IAC7D,yCAAyC,CAAC,UAAwB;AAAA,EACpE;AAEA,QAAM,aAAmF,EAAE,GAAG,iBAAiB,GAAG,QAAQ;AAC1H,QAAM,YAAY;AAClB,QAAM,iBAAiB;AACvB,QAAM,mBAAmB,MAAsB,WAAW,kBAAkB,UAAU;AACtF,iBACG,SAAS,WAAW,wCAAwC,iBAAiB,EAAE,QAAQ,CAAC,CAAC,EACzF,SAAS,OAAO,YAAY;AAC3B,QAAI,CAAC,kBAAkB,OAAO,GAAG;AAC/B;AAAA,IACF;AACA,UAAM,iBAAiB,iBAAiB;AACxC,mBAAe,QAAQ,IAAI,WAAW,wCAAwC,OAAO;AACrF,QAAI,WAAW,UAAU;AACvB,YAAM,UAAU,aAAa,cAAc;AAAA,IAC7C;AAEA,UAAM,WAAW,YAAY;AAAA,EAC/B,CAAC;AAEH,QAAM,mBAAmB,oBAAoB,cAAc;AAC3D,MAAI,kBAAkB;AACpB,qBAAiB,iBAAiB,SAAS,MAAM,kBAAkB,CAAC;AACpE,qBAAiB,iBAAiB,QAAQ,MAAM,kBAAkB,CAAC;AAAA,EACrE;AAEA,SAAO;AAEP,WAAS,kBAAkB,SAA4B;AACrD,QAAI,CAAC,WAAW,gBAAgB;AAC9B,aAAO;AAAA,IACT;AACA,gBAAY,eAAe,SAAS;AACpC,UAAM,eAAe,WAAW,eAAe,OAAO;AACtD,UAAMA,oBAAmB,oBAAoB,cAAc;AAC3D,QAAIA,mBAAkB;AACpB,MAAAA,kBAAiB,kBAAkB,gBAAgB,EAAE;AACrD,MAAAA,kBAAiB,eAAe;AAAA,IAClC;AAEA,WAAO,CAAC;AAAA,EACV;AACF;AAQA,SAAS,oBAAoB,gBAAkE;AAC7F,MAAI,0BAA0B,mCAAmB;AAC/C,WAAO,eAAe;AAAA,EACxB;AAEA,MAAI,0BAA0B,iCAAiB;AAC7C,WAAO,eAAe;AAAA,EACxB;AAEA,MAAI,0BAA0B,mCAAmB;AAC/C,WAAO,eAAe;AAAA,EACxB;AAEA,MAAI,0BAA0B,+BAAe;AAC3C,WAAO,eAAe;AAAA,EACxB;AAEA,SAAO;AACT;",
  "names": ["validatorElement"]
}

|
@@ -0,0 +1,97 @@
|
|
1
|
+
import type { KeysMatching } from '../../@types.ts';
|
2
|
+
import type { MaybePromise } from '../../Async.ts';
|
3
|
+
import type { PluginBase } from './PluginBase.ts';
|
4
|
+
/**
|
5
|
+
* A ValueComponent that can be bound to a plugin setting.
|
6
|
+
*/
|
7
|
+
export interface ValueComponent<UIValue> {
|
8
|
+
/**
|
9
|
+
* Gets the value of the component.
|
10
|
+
*
|
11
|
+
* @returns The value of the component.
|
12
|
+
*/
|
13
|
+
getValue(): UIValue;
|
14
|
+
/**
|
15
|
+
* Sets the value of the component.
|
16
|
+
* @param value - The value to set on the component.
|
17
|
+
*/
|
18
|
+
setValue(value: UIValue): this;
|
19
|
+
/**
|
20
|
+
* Sets a callback function to be called when the value of the component changes.
|
21
|
+
* @param callback - A callback function that is called when the value of the component changes.
|
22
|
+
*/
|
23
|
+
onChange(callback: (newValue: UIValue) => Promise<void>): this;
|
24
|
+
}
|
25
|
+
/**
|
26
|
+
* Options for binding a value component to a plugin setting.
|
27
|
+
*/
|
28
|
+
interface BindValueComponentOptions<PluginSettings, UIValue> {
|
29
|
+
/**
|
30
|
+
* If true, saves the plugin settings automatically after the component value changes. Default is `true`.
|
31
|
+
*/
|
32
|
+
autoSave?: boolean;
|
33
|
+
/**
|
34
|
+
* The plugin settings object to bind the component to. Default is the plugin's current settings.
|
35
|
+
*/
|
36
|
+
pluginSettings?: PluginSettings;
|
37
|
+
/**
|
38
|
+
* Validates the UI value before setting it on the plugin settings.
|
39
|
+
* @param uiValue - The value of the UI component.
|
40
|
+
* @returns An error message if the value is invalid, or `null` if it is valid.
|
41
|
+
*/
|
42
|
+
valueValidator?: (uiValue: UIValue) => string | null;
|
43
|
+
/**
|
44
|
+
* A callback function that is called when the value of the component changes.
|
45
|
+
*/
|
46
|
+
onChanged?: () => MaybePromise<void>;
|
47
|
+
}
|
48
|
+
/**
|
49
|
+
* Extended options for binding a value component to a plugin setting.
|
50
|
+
*/
|
51
|
+
interface BindValueComponentOptionsExtended<PluginSettings, UIValue, Property extends keyof PluginSettings> extends BindValueComponentOptions<PluginSettings, UIValue> {
|
52
|
+
/**
|
53
|
+
* Converts the plugin settings value to the value used by the UI component.
|
54
|
+
* @param pluginSettingsValue - The value of the property in the plugin settings.
|
55
|
+
* @returns The value to set on the UI component.
|
56
|
+
*/
|
57
|
+
pluginSettingsToComponentValueConverter: (pluginSettingsValue: PluginSettings[Property]) => UIValue;
|
58
|
+
/**
|
59
|
+
* Converts the UI component's value back to the plugin settings value.
|
60
|
+
* @param uiValue - The value of the UI component.
|
61
|
+
* @returns The value to set on the plugin settings.
|
62
|
+
*/
|
63
|
+
componentToPluginSettingsValueConverter: (uiValue: UIValue) => PluginSettings[Property];
|
64
|
+
}
|
65
|
+
/**
|
66
|
+
* Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.
|
67
|
+
*
|
68
|
+
* @typeParam Plugin - The type of the plugin that extends `PluginBase`.
|
69
|
+
* @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
|
70
|
+
* @typeParam Property - The key of the plugin setting that the component is bound to.
|
71
|
+
* @typeParam UIValue - The inferred type based on the UI component's type.
|
72
|
+
* @typeParam PluginSettings - The inferred type of the plugin settings object.
|
73
|
+
*
|
74
|
+
* @param plugin - The plugin.
|
75
|
+
* @param valueComponent - The component that will display and interact with the setting value.
|
76
|
+
* @param property - The property key in `PluginSettings` to bind to the UI component.
|
77
|
+
* @param options - Configuration options.
|
78
|
+
* @returns The `ValueComponent` instance that was bound to the property.
|
79
|
+
*/
|
80
|
+
export declare function bindValueComponent<Plugin extends PluginBase<object>, TValueComponent extends ValueComponent<unknown>, Property extends KeysMatching<PluginSettings, UIValue>, UIValue = TValueComponent extends ValueComponent<infer P> ? P : never, PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never>(plugin: Plugin, valueComponent: TValueComponent, property: Property, options?: BindValueComponentOptions<PluginSettings, UIValue>): TValueComponent;
|
81
|
+
/**
|
82
|
+
* Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.
|
83
|
+
*
|
84
|
+
* @typeParam Plugin - The type of the plugin that extends `PluginBase`.
|
85
|
+
* @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
|
86
|
+
* @typeParam Property - The key of the plugin setting that the component is bound to.
|
87
|
+
* @typeParam UIValue - The inferred type based on the value component's type.
|
88
|
+
* @typeParam PluginSettings - The inferred type of the plugin settings object.
|
89
|
+
*
|
90
|
+
* @param plugin - The plugin.
|
91
|
+
* @param valueComponent - The component that will display and interact with the setting value.
|
92
|
+
* @param property - The property key in `PluginSettings` to bind to the UI component.
|
93
|
+
* @param options - Configuration options.
|
94
|
+
* @returns The `ValueComponent` instance that was bound to the property.
|
95
|
+
*/
|
96
|
+
export declare function bindValueComponent<Plugin extends PluginBase<object>, TValueComponent extends ValueComponent<unknown>, Property extends keyof PluginSettings, UIValue = TValueComponent extends ValueComponent<infer P> ? P : never, PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never>(plugin: Plugin, valueComponent: TValueComponent, property: Property, options: BindValueComponentOptionsExtended<PluginSettings, UIValue, Property>): TValueComponent;
|
97
|
+
export {};
|
@@ -40,7 +40,7 @@ __export(Plugin_exports, {
|
|
40
40
|
PluginBase: () => PluginBase,
|
41
41
|
PluginSettings: () => PluginSettings,
|
42
42
|
PluginSettingsTabBase: () => PluginSettingsTabBase,
|
43
|
-
|
43
|
+
ValueComponent: () => ValueComponent
|
44
44
|
});
|
45
45
|
module.exports = __toCommonJS(Plugin_exports);
|
46
46
|
var ObsidianPluginRepoPaths = __toESM(require('./ObsidianPluginRepoPaths.cjs'), 1);
|
@@ -48,7 +48,7 @@ var Plugin = __toESM(require('./Plugin.cjs'), 1);
|
|
48
48
|
var PluginBase = __toESM(require('./PluginBase.cjs'), 1);
|
49
49
|
var PluginSettings = __toESM(require('./PluginSettings.cjs'), 1);
|
50
50
|
var PluginSettingsTabBase = __toESM(require('./PluginSettingsTabBase.cjs'), 1);
|
51
|
-
var
|
51
|
+
var ValueComponent = __toESM(require('./ValueComponent.cjs'), 1);
|
52
52
|
// Annotate the CommonJS export names for ESM import in node:
|
53
53
|
0 && (module.exports = {
|
54
54
|
ObsidianPluginRepoPaths,
|
@@ -56,6 +56,6 @@ var UIComponent = __toESM(require('./UIComponent.cjs'), 1);
|
|
56
56
|
PluginBase,
|
57
57
|
PluginSettings,
|
58
58
|
PluginSettingsTabBase,
|
59
|
-
|
59
|
+
ValueComponent
|
60
60
|
});
|
61
|
-
//# sourceMappingURL=data:application/json;base64,
|
61
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9pbmRleC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyogVEhJUyBJUyBBIEdFTkVSQVRFRC9CVU5ETEVEIEZJTEUgQlkgQlVJTEQgU0NSSVBUICovXG5cbmV4cG9ydCAqIGFzIE9ic2lkaWFuUGx1Z2luUmVwb1BhdGhzIGZyb20gJy4vT2JzaWRpYW5QbHVnaW5SZXBvUGF0aHMudHMnO1xuZXhwb3J0ICogYXMgUGx1Z2luIGZyb20gJy4vUGx1Z2luLnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpbkJhc2UgZnJvbSAnLi9QbHVnaW5CYXNlLnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpblNldHRpbmdzIGZyb20gJy4vUGx1Z2luU2V0dGluZ3MudHMnO1xuZXhwb3J0ICogYXMgUGx1Z2luU2V0dGluZ3NUYWJCYXNlIGZyb20gJy4vUGx1Z2luU2V0dGluZ3NUYWJCYXNlLnRzJztcbmV4cG9ydCAqIGFzIFZhbHVlQ29tcG9uZW50IGZyb20gJy4vVmFsdWVDb21wb25lbnQudHMnO1xuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUVBLDhCQUF5QztBQUN6QyxhQUF3QjtBQUN4QixpQkFBNEI7QUFDNUIscUJBQWdDO0FBQ2hDLDRCQUF1QztBQUN2QyxxQkFBZ0M7IiwKICAibmFtZXMiOiBbXQp9Cg==
|
@@ -3,4 +3,4 @@ export * as Plugin from './Plugin.ts';
|
|
3
3
|
export * as PluginBase from './PluginBase.ts';
|
4
4
|
export * as PluginSettings from './PluginSettings.ts';
|
5
5
|
export * as PluginSettingsTabBase from './PluginSettingsTabBase.ts';
|
6
|
-
export * as
|
6
|
+
export * as ValueComponent from './ValueComponent.ts';
|
package/package.json
CHANGED
@@ -1,81 +0,0 @@
|
|
1
|
-
/*
|
2
|
-
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
3
|
-
if you want to view the source, please visit the github repository of this plugin
|
4
|
-
*/
|
5
|
-
|
6
|
-
(function patchRequireEsmDefault(){const __require=require;require=Object.assign(id=>{const module=__require(id);return module.__esModule&&module.default?module.default:module},__require)})()
|
7
|
-
|
8
|
-
"use strict";
|
9
|
-
var __defProp = Object.defineProperty;
|
10
|
-
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
11
|
-
var __getOwnPropNames = Object.getOwnPropertyNames;
|
12
|
-
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
13
|
-
var __export = (target, all) => {
|
14
|
-
for (var name in all)
|
15
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
16
|
-
};
|
17
|
-
var __copyProps = (to, from, except, desc) => {
|
18
|
-
if (from && typeof from === "object" || typeof from === "function") {
|
19
|
-
for (let key of __getOwnPropNames(from))
|
20
|
-
if (!__hasOwnProp.call(to, key) && key !== except)
|
21
|
-
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
22
|
-
}
|
23
|
-
return to;
|
24
|
-
};
|
25
|
-
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
26
|
-
var UIComponent_exports = {};
|
27
|
-
__export(UIComponent_exports, {
|
28
|
-
bindUiComponent: () => bindUiComponent
|
29
|
-
});
|
30
|
-
module.exports = __toCommonJS(UIComponent_exports);
|
31
|
-
var import_obsidian = require('obsidian');
|
32
|
-
function bindUiComponent(plugin, uiComponent, property, options) {
|
33
|
-
const DEFAULT_OPTIONS = {
|
34
|
-
autoSave: true,
|
35
|
-
settingToUIValueConverter: (value) => value,
|
36
|
-
uiToSettingValueConverter: (value) => value
|
37
|
-
};
|
38
|
-
const optionsExt = { ...DEFAULT_OPTIONS, ...options };
|
39
|
-
const pluginExt = plugin;
|
40
|
-
const uiComponentExt = uiComponent;
|
41
|
-
const pluginSettingsFn = () => optionsExt.pluginSettings ?? pluginExt.settingsCopy;
|
42
|
-
uiComponentExt.setValue(optionsExt.settingToUIValueConverter(pluginSettingsFn()[property])).onChange(async (uiValue) => {
|
43
|
-
if (optionsExt.uiValueValidator) {
|
44
|
-
const errorMessage = optionsExt.uiValueValidator(uiValue);
|
45
|
-
const validatorElement = getValidatorElement(uiComponent);
|
46
|
-
if (validatorElement) {
|
47
|
-
validatorElement.setCustomValidity(errorMessage ?? "");
|
48
|
-
validatorElement.reportValidity();
|
49
|
-
}
|
50
|
-
if (errorMessage) {
|
51
|
-
return;
|
52
|
-
}
|
53
|
-
}
|
54
|
-
const pluginSettings = pluginSettingsFn();
|
55
|
-
pluginSettings[property] = optionsExt.uiToSettingValueConverter(uiValue);
|
56
|
-
if (optionsExt.autoSave) {
|
57
|
-
await pluginExt.saveSettings(pluginSettings);
|
58
|
-
}
|
59
|
-
});
|
60
|
-
return uiComponent;
|
61
|
-
}
|
62
|
-
function getValidatorElement(uiComponent) {
|
63
|
-
if (uiComponent instanceof import_obsidian.DropdownComponent) {
|
64
|
-
return uiComponent.selectEl;
|
65
|
-
}
|
66
|
-
if (uiComponent instanceof import_obsidian.SliderComponent) {
|
67
|
-
return uiComponent.sliderEl;
|
68
|
-
}
|
69
|
-
if (uiComponent instanceof import_obsidian.TextAreaComponent) {
|
70
|
-
return uiComponent.inputEl;
|
71
|
-
}
|
72
|
-
if (uiComponent instanceof import_obsidian.TextComponent) {
|
73
|
-
return uiComponent.inputEl;
|
74
|
-
}
|
75
|
-
return null;
|
76
|
-
}
|
77
|
-
// Annotate the CommonJS export names for ESM import in node:
|
78
|
-
0 && (module.exports = {
|
79
|
-
bindUiComponent
|
80
|
-
});
|
81
|
-
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/obsidian/Plugin/UIComponent.ts"],
  "sourcesContent": ["import {\n  DropdownComponent,\n  SliderComponent,\n  TextAreaComponent,\n  TextComponent\n} from 'obsidian';\n\nimport type { KeysMatching } from '../../@types.ts';\nimport type { PluginBase } from './PluginBase.ts';\n\n/**\n * A UI component that can be bound to a plugin setting.\n */\nexport interface UIComponent<UIValue> {\n  /**\n   * Sets the value of the component.\n   * @param value - The value to set on the component.\n   */\n  setValue(value: UIValue): this;\n\n  /**\n   * Sets a callback function to be called when the value of the component changes.\n   * @param callback - A callback function that is called when the value of the component changes.\n   */\n  onChange(callback: (newValue: UIValue) => Promise<void>): this;\n}\n\n/**\n * A UI component that can be validated.\n */\ninterface ValidatorElement {\n  /**\n   * Sets a custom error message on the element.\n   * @param error - The error message to set on the element.\n   */\n  setCustomValidity(error: string): void;\n\n  /**\n   * Reports the validity of the element.\n   */\n  reportValidity(): boolean;\n}\n\n/**\n * Options for binding a value component to a plugin setting.\n */\ninterface BindUIComponentOptions<PluginSettings, UIValueType> {\n  /**\n   * If true, saves the plugin settings automatically after the component value changes. Default is `true`.\n   */\n  autoSave?: boolean;\n\n  /**\n   * The plugin settings object to bind the component to. Default is the plugin's current settings.\n   */\n  pluginSettings?: PluginSettings;\n\n  /**\n   * Validates the UI value before setting it on the plugin settings.\n   * @param uiValue - The value of the UI component.\n   * @returns An error message if the value is invalid, or `null` if it is valid.\n   */\n  uiValueValidator?: (uiValue: UIValueType) => string | null;\n}\n\n/**\n * Extended options for binding a value component to a plugin setting.\n */\ninterface BindUIComponentOptionsExtended<PluginSettings, UIValueType, Property extends keyof PluginSettings> extends BindUIComponentOptions<PluginSettings, UIValueType> {\n  /**\n * Converts the setting value to the value used by the UI component.\n * @param propertyValue - The value of the property in the plugin settings.\n * @returns The value to set on the UI component.\n */\n  settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType;\n\n  /**\n   * Converts the UI component's value back to the setting value.\n   * @param uiValue - The value of the UI component.\n   * @returns The value to set on the plugin settings.\n   */\n  uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property];\n}\n\n/**\n * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n *\n * @typeParam Plugin - The type of the plugin that extends `PluginBase`.\n * @typeParam TUIComponent - The type of the value component extending `UIComponent`.\n * @typeParam Property - The key of the plugin setting that the component is bound to.\n * @typeParam UIValueType - The inferred type based on the UI component's type.\n * @typeParam PluginSettings - The inferred type of the plugin settings object.\n *\n * @param plugin - The plugin.\n * @param uiComponent - The component that will display and interact with the setting value.\n * @param property - The property key in `PluginSettings` to bind to the UI component.\n * @param options - Configuration options.\n *\n * @returns The `UIComponent` instance that was bound to the property.\n */\nexport function bindUiComponent<\n  Plugin extends PluginBase<object>,\n  TUIComponent extends UIComponent<unknown>,\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters\n  Property extends KeysMatching<PluginSettings, UIValueType>,\n  UIValueType = TUIComponent extends UIComponent<infer P> ? P : never,\n  PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never\n>(\n  plugin: Plugin,\n  uiComponent: TUIComponent,\n  property: Property,\n  options?: BindUIComponentOptions<PluginSettings, UIValueType>\n): TUIComponent;\n\n/**\n * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n *\n * @typeParam Plugin - The type of the plugin that extends `PluginBase`.\n * @typeParam TUIComponent - The type of the value component extending `UIComponent`.\n * @typeParam Property - The key of the plugin setting that the component is bound to.\n * @typeParam UIValueType - The inferred type based on the UI component's type.\n * @typeParam PluginSettings - The inferred type of the plugin settings object.\n *\n * @param plugin - The plugin.\n * @param uiComponent - The component that will display and interact with the setting value.\n * @param property - The property key in `PluginSettings` to bind to the UI component.\n * @param options - Configuration options.\n *\n * @returns The `UIComponent` instance that was bound to the property.\n */\nexport function bindUiComponent<\n  Plugin extends PluginBase<object>,\n  TUIComponent extends UIComponent<unknown>,\n  Property extends keyof PluginSettings,\n  UIValueType = TUIComponent extends UIComponent<infer P> ? P : never,\n  PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never\n>(\n  plugin: Plugin,\n  uiComponent: TUIComponent,\n  property: Property,\n  options: BindUIComponentOptionsExtended<PluginSettings, UIValueType, Property>\n): TUIComponent;\n\n/**\n * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n *\n * @typeParam Plugin - The type of the plugin that extends `PluginBase`.\n * @typeParam TUIComponent - The type of the value component extending `UIComponent`.\n * @typeParam Property - The key of the plugin setting that the component is bound to.\n * @typeParam UIValueType - The inferred type based on the UI component's type.\n * @typeParam PluginSettings - The inferred type of the plugin settings object.\n *\n * @param plugin - The plugin.\n * @param uiComponent - The component that will display and interact with the setting value.\n * @param property - The property key in `PluginSettings` to bind to the UI component.\n * @param options - Configuration options.\n *\n * @returns The `UIComponent` instance that was bound to the property.\n */\nexport function bindUiComponent<\n  Plugin extends PluginBase<object>,\n  TUIComponent extends UIComponent<unknown>,\n  Property extends keyof PluginSettings,\n  UIValueType = TUIComponent extends UIComponent<infer P> ? P : never,\n  PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never\n>(\n  plugin: Plugin,\n  uiComponent: TUIComponent,\n  property: Property,\n  options?: BindUIComponentOptions<PluginSettings, UIValueType>\n): TUIComponent {\n  type PropertyType = PluginSettings[Property];\n  const DEFAULT_OPTIONS: BindUIComponentOptionsExtended<PluginSettings, UIValueType, Property> = {\n    autoSave: true,\n    settingToUIValueConverter: (value): UIValueType => value as UIValueType,\n    uiToSettingValueConverter: (value): PropertyType => value as PropertyType\n  };\n\n  const optionsExt: BindUIComponentOptionsExtended<PluginSettings, UIValueType, Property> = { ...DEFAULT_OPTIONS, ...options };\n  const pluginExt = plugin as unknown as PluginBase<PluginSettings>;\n  const uiComponentExt = uiComponent as UIComponent<UIValueType>;\n  const pluginSettingsFn = (): PluginSettings => optionsExt.pluginSettings ?? pluginExt.settingsCopy;\n  uiComponentExt\n    .setValue(optionsExt.settingToUIValueConverter(pluginSettingsFn()[property]))\n    .onChange(async (uiValue) => {\n      if (optionsExt.uiValueValidator) {\n        const errorMessage = optionsExt.uiValueValidator(uiValue);\n        const validatorElement = getValidatorElement(uiComponent);\n        if (validatorElement) {\n          validatorElement.setCustomValidity(errorMessage ?? '');\n          validatorElement.reportValidity();\n        }\n        if (errorMessage) {\n          return;\n        }\n      }\n      const pluginSettings = pluginSettingsFn();\n      pluginSettings[property] = optionsExt.uiToSettingValueConverter(uiValue);\n      if (optionsExt.autoSave) {\n        await pluginExt.saveSettings(pluginSettings);\n      }\n    });\n  return uiComponent;\n}\n\n/**\n * Gets the validator element from a UI component if it exists.\n * @param uiComponent - The UI component to get the validator element from.\n * @returns The validator element if it exists, or `null` if it does not.\n */\nfunction getValidatorElement(uiComponent: UIComponent<unknown>): ValidatorElement | null {\n  if (uiComponent instanceof DropdownComponent) {\n    return uiComponent.selectEl;\n  }\n\n  if (uiComponent instanceof SliderComponent) {\n    return uiComponent.sliderEl;\n  }\n\n  if (uiComponent instanceof TextAreaComponent) {\n    return uiComponent.inputEl;\n  }\n\n  if (uiComponent instanceof TextComponent) {\n    return uiComponent.inputEl;\n  }\n\n  return null;\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAKO;AA0JA,SAAS,gBAOd,QACA,aACA,UACA,SACc;AAEd,QAAM,kBAAyF;AAAA,IAC7F,UAAU;AAAA,IACV,2BAA2B,CAAC,UAAuB;AAAA,IACnD,2BAA2B,CAAC,UAAwB;AAAA,EACtD;AAEA,QAAM,aAAoF,EAAE,GAAG,iBAAiB,GAAG,QAAQ;AAC3H,QAAM,YAAY;AAClB,QAAM,iBAAiB;AACvB,QAAM,mBAAmB,MAAsB,WAAW,kBAAkB,UAAU;AACtF,iBACG,SAAS,WAAW,0BAA0B,iBAAiB,EAAE,QAAQ,CAAC,CAAC,EAC3E,SAAS,OAAO,YAAY;AAC3B,QAAI,WAAW,kBAAkB;AAC/B,YAAM,eAAe,WAAW,iBAAiB,OAAO;AACxD,YAAM,mBAAmB,oBAAoB,WAAW;AACxD,UAAI,kBAAkB;AACpB,yBAAiB,kBAAkB,gBAAgB,EAAE;AACrD,yBAAiB,eAAe;AAAA,MAClC;AACA,UAAI,cAAc;AAChB;AAAA,MACF;AAAA,IACF;AACA,UAAM,iBAAiB,iBAAiB;AACxC,mBAAe,QAAQ,IAAI,WAAW,0BAA0B,OAAO;AACvE,QAAI,WAAW,UAAU;AACvB,YAAM,UAAU,aAAa,cAAc;AAAA,IAC7C;AAAA,EACF,CAAC;AACH,SAAO;AACT;AAOA,SAAS,oBAAoB,aAA4D;AACvF,MAAI,uBAAuB,mCAAmB;AAC5C,WAAO,YAAY;AAAA,EACrB;AAEA,MAAI,uBAAuB,iCAAiB;AAC1C,WAAO,YAAY;AAAA,EACrB;AAEA,MAAI,uBAAuB,mCAAmB;AAC5C,WAAO,YAAY;AAAA,EACrB;AAEA,MAAI,uBAAuB,+BAAe;AACxC,WAAO,YAAY;AAAA,EACrB;AAEA,SAAO;AACT;",
  "names": []
}

|
@@ -1,88 +0,0 @@
|
|
1
|
-
import type { KeysMatching } from '../../@types.ts';
|
2
|
-
import type { PluginBase } from './PluginBase.ts';
|
3
|
-
/**
|
4
|
-
* A UI component that can be bound to a plugin setting.
|
5
|
-
*/
|
6
|
-
export interface UIComponent<UIValue> {
|
7
|
-
/**
|
8
|
-
* Sets the value of the component.
|
9
|
-
* @param value - The value to set on the component.
|
10
|
-
*/
|
11
|
-
setValue(value: UIValue): this;
|
12
|
-
/**
|
13
|
-
* Sets a callback function to be called when the value of the component changes.
|
14
|
-
* @param callback - A callback function that is called when the value of the component changes.
|
15
|
-
*/
|
16
|
-
onChange(callback: (newValue: UIValue) => Promise<void>): this;
|
17
|
-
}
|
18
|
-
/**
|
19
|
-
* Options for binding a value component to a plugin setting.
|
20
|
-
*/
|
21
|
-
interface BindUIComponentOptions<PluginSettings, UIValueType> {
|
22
|
-
/**
|
23
|
-
* If true, saves the plugin settings automatically after the component value changes. Default is `true`.
|
24
|
-
*/
|
25
|
-
autoSave?: boolean;
|
26
|
-
/**
|
27
|
-
* The plugin settings object to bind the component to. Default is the plugin's current settings.
|
28
|
-
*/
|
29
|
-
pluginSettings?: PluginSettings;
|
30
|
-
/**
|
31
|
-
* Validates the UI value before setting it on the plugin settings.
|
32
|
-
* @param uiValue - The value of the UI component.
|
33
|
-
* @returns An error message if the value is invalid, or `null` if it is valid.
|
34
|
-
*/
|
35
|
-
uiValueValidator?: (uiValue: UIValueType) => string | null;
|
36
|
-
}
|
37
|
-
/**
|
38
|
-
* Extended options for binding a value component to a plugin setting.
|
39
|
-
*/
|
40
|
-
interface BindUIComponentOptionsExtended<PluginSettings, UIValueType, Property extends keyof PluginSettings> extends BindUIComponentOptions<PluginSettings, UIValueType> {
|
41
|
-
/**
|
42
|
-
* Converts the setting value to the value used by the UI component.
|
43
|
-
* @param propertyValue - The value of the property in the plugin settings.
|
44
|
-
* @returns The value to set on the UI component.
|
45
|
-
*/
|
46
|
-
settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType;
|
47
|
-
/**
|
48
|
-
* Converts the UI component's value back to the setting value.
|
49
|
-
* @param uiValue - The value of the UI component.
|
50
|
-
* @returns The value to set on the plugin settings.
|
51
|
-
*/
|
52
|
-
uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property];
|
53
|
-
}
|
54
|
-
/**
|
55
|
-
* Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.
|
56
|
-
*
|
57
|
-
* @typeParam Plugin - The type of the plugin that extends `PluginBase`.
|
58
|
-
* @typeParam TUIComponent - The type of the value component extending `UIComponent`.
|
59
|
-
* @typeParam Property - The key of the plugin setting that the component is bound to.
|
60
|
-
* @typeParam UIValueType - The inferred type based on the UI component's type.
|
61
|
-
* @typeParam PluginSettings - The inferred type of the plugin settings object.
|
62
|
-
*
|
63
|
-
* @param plugin - The plugin.
|
64
|
-
* @param uiComponent - The component that will display and interact with the setting value.
|
65
|
-
* @param property - The property key in `PluginSettings` to bind to the UI component.
|
66
|
-
* @param options - Configuration options.
|
67
|
-
*
|
68
|
-
* @returns The `UIComponent` instance that was bound to the property.
|
69
|
-
*/
|
70
|
-
export declare function bindUiComponent<Plugin extends PluginBase<object>, TUIComponent extends UIComponent<unknown>, Property extends KeysMatching<PluginSettings, UIValueType>, UIValueType = TUIComponent extends UIComponent<infer P> ? P : never, PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never>(plugin: Plugin, uiComponent: TUIComponent, property: Property, options?: BindUIComponentOptions<PluginSettings, UIValueType>): TUIComponent;
|
71
|
-
/**
|
72
|
-
* Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.
|
73
|
-
*
|
74
|
-
* @typeParam Plugin - The type of the plugin that extends `PluginBase`.
|
75
|
-
* @typeParam TUIComponent - The type of the value component extending `UIComponent`.
|
76
|
-
* @typeParam Property - The key of the plugin setting that the component is bound to.
|
77
|
-
* @typeParam UIValueType - The inferred type based on the UI component's type.
|
78
|
-
* @typeParam PluginSettings - The inferred type of the plugin settings object.
|
79
|
-
*
|
80
|
-
* @param plugin - The plugin.
|
81
|
-
* @param uiComponent - The component that will display and interact with the setting value.
|
82
|
-
* @param property - The property key in `PluginSettings` to bind to the UI component.
|
83
|
-
* @param options - Configuration options.
|
84
|
-
*
|
85
|
-
* @returns The `UIComponent` instance that was bound to the property.
|
86
|
-
*/
|
87
|
-
export declare function bindUiComponent<Plugin extends PluginBase<object>, TUIComponent extends UIComponent<unknown>, Property extends keyof PluginSettings, UIValueType = TUIComponent extends UIComponent<infer P> ? P : never, PluginSettings extends object = Plugin extends PluginBase<infer P> ? P : never>(plugin: Plugin, uiComponent: TUIComponent, property: Property, options: BindUIComponentOptionsExtended<PluginSettings, UIValueType, Property>): TUIComponent;
|
88
|
-
export {};
|