obsidian-dev-utils 1.6.0 → 1.7.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 1.7.1
+
+- Make proper `bindValueComponent` overloads
+
+## 1.7.0
+
+- Allow convert plugin setting values
+
 ## 1.6.0
 
 - Serialize JSON with functions

package/dist/lib/obsidian/Plugin/PluginSettingsTabBase.cjs

@@ -45,20 +45,29 @@ class PluginSettingsTabBase extends import_obsidian.PluginSettingTab {
     this.plugin = plugin;
   }
   /**
-   * Binds a value component to a specific property in the plugin settings.
-   * Updates the plugin settings when the value component's value changes.
+   * Internal implementation of `bindValueComponent` that handles both overloads.
    *
-   * @template TValueComponent - The type of the value component.
-   * @template Property - The type of the property in the plugin settings that the value component is bound to.
-   * @param {TValueComponent} valueComponent - The value component to bind.
-   * @param {PluginSettings} pluginSettings - The plugin settings object.
-   * @param {Property} property - The property in the plugin settings to bind the value component to.
-   * @param {boolean} [autoSave=true] - Whether to automatically save settings when the value changes.
-   * @returns {TValueComponent} The bound value component.
+   * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
+   * @typeParam Property - The key of the plugin setting that the component is bound to.
+   * @typeParam UIValueType - The inferred type of the UI value based on the value component's type.
+   *
+   * @param valueComponent - The component that will display and interact with the setting value.
+   * @param property - The property key in `PluginSettings` to bind to the component.
+   * @param options - Configuration options.
+   * @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.
+   * @param options.settingToUIValueConverter - A function that converts the setting value to the value used by the UI component.
+   * @param options.uiToSettingValueConverter - A function that converts the UI component's value back to the setting value.
+   *
+   * @returns The `TValueComponent` instance that was bound to the property.
    */
-  bindValueComponent(valueComponent, pluginSettings, property, autoSave = true) {
-    valueComponent.setValue(pluginSettings[property]).onChange(async (newValue) => {
-      pluginSettings[property] = newValue;
+  bindValueComponent(valueComponent, property, {
+    autoSave,
+    settingToUIValueConverter,
+    uiToSettingValueConverter
+  }) {
+    const pluginSettings = this.plugin.settingsCopy;
+    valueComponent.setValue(settingToUIValueConverter(pluginSettings[property])).onChange(async (newValue) => {
+      pluginSettings[property] = uiToSettingValueConverter(newValue);
       if (autoSave) {
         await this.plugin.saveSettings(pluginSettings);
       }
@@ -70,4 +79,4 @@ class PluginSettingsTabBase extends import_obsidian.PluginSettingTab {
 0 && (module.exports = {
   PluginSettingsTabBase
 });
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9QbHVnaW5TZXR0aW5nc1RhYkJhc2UudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbImNvbnN0IF9faW1wb3J0X21ldGFfdXJsID0gZ2xvYmFsVGhpc1tcImltcG9ydC5tZXRhLnVybFwiXSA/PyAoKCk9PnJlcXVpcmUoXCJub2RlOnVybFwiKS5wYXRoVG9GaWxlVVJMKF9fZmlsZW5hbWUpKSgpO1xuY29uc3QgX19wcm9jZXNzID0gZ2xvYmFsVGhpc1tcInByb2Nlc3NcIl0gPz8ge1xuICBcImN3ZFwiOiAoKT0+XCIvXCIsXG4gIFwiZW52XCI6IHt9LFxuICBcInBsYXRmb3JtXCI6IFwiYW5kcm9pZFwiXG59O1xuLyoqXG4gKiBAZmlsZSBUaGlzIG1vZHVsZSBkZWZpbmVzIGEgYmFzZSBjbGFzcyBmb3IgY3JlYXRpbmcgcGx1Z2luIHNldHRpbmcgdGFicyBpbiBPYnNpZGlhbi5cbiAqIEl0IHByb3ZpZGVzIGEgdXRpbGl0eSBtZXRob2QgdG8gYmluZCB2YWx1ZSBjb21wb25lbnRzIHRvIHBsdWdpbiBzZXR0aW5ncyBhbmQgaGFuZGxlIGNoYW5nZXMuXG4gKi9cblxuaW1wb3J0IHsgUGx1Z2luU2V0dGluZ1RhYiB9IGZyb20gXCJvYnNpZGlhblwiO1xuaW1wb3J0IHsgUGx1Z2luQmFzZSB9IGZyb20gXCIuL1BsdWdpbkJhc2UudHNcIjtcbmltcG9ydCB0eXBlIHsgS2V5c01hdGNoaW5nIH0gZnJvbSBcIi4uLy4uL0B0eXBlcy50c1wiO1xuXG5pbnRlcmZhY2UgVmFsdWVDb21wb25lbnQ8VD4ge1xuICBzZXRWYWx1ZSh2YWx1ZTogVCk6IHRoaXM7XG4gIG9uQ2hhbmdlKGNhbGxiYWNrOiAobmV3VmFsdWU6IFQpID0+IFByb21pc2U8dm9pZD4pOiB0aGlzO1xufVxuXG4vKipcbiAqIEJhc2UgY2xhc3MgZm9yIGNyZWF0aW5nIHBsdWdpbiBzZXR0aW5ncyB0YWJzIGluIE9ic2lkaWFuLlxuICogUHJvdmlkZXMgYSBtZXRob2QgZm9yIGJpbmRpbmcgdmFsdWUgY29tcG9uZW50cyB0byBwbHVnaW4gc2V0dGluZ3MgYW5kIGhhbmRsaW5nIGNoYW5nZXMuXG4gKlxuICogQHRlbXBsYXRlIFRQbHVnaW4gLSBUaGUgdHlwZSBvZiB0aGUgcGx1Z2luIHRoYXQgZXh0ZW5kcyBQbHVnaW5CYXNlLlxuICogQHRlbXBsYXRlIFBsdWdpblNldHRpbmdzIC0gVGhlIHR5cGUgb2YgdGhlIHBsdWdpbiBzZXR0aW5ncyBvYmplY3QuXG4gKi9cbmV4cG9ydCBhYnN0cmFjdCBjbGFzcyBQbHVnaW5TZXR0aW5nc1RhYkJhc2U8XG4gIFRQbHVnaW4gZXh0ZW5kcyBQbHVnaW5CYXNlPFBsdWdpblNldHRpbmdzPixcbiAgUGx1Z2luU2V0dGluZ3MgZXh0ZW5kcyBvYmplY3Rcbj4gZXh0ZW5kcyBQbHVnaW5TZXR0aW5nVGFiIHtcbiAgLyoqXG4gICAqIENyZWF0ZXMgYW4gaW5zdGFuY2Ugb2YgUGx1Z2luU2V0dGluZ3NUYWJCYXNlLlxuICAgKlxuICAgKiBAcGFyYW0ge1RQbHVnaW59IHBsdWdpbiAtIFRoZSBwbHVnaW4gaW5zdGFuY2UgdG8gd2hpY2ggdGhpcyBzZXR0aW5ncyB0YWIgYmVsb25ncy5cbiAgICovXG4gIHB1YmxpYyBjb25zdHJ1Y3RvcihwdWJsaWMgb3ZlcnJpZGUgcGx1Z2luOiBUUGx1Z2luKSB7XG4gICAgc3VwZXIocGx1Z2luLmFwcCwgcGx1Z2luKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBCaW5kcyBhIHZhbHVlIGNvbXBvbmVudCB0byBhIHNwZWNpZmljIHByb3BlcnR5IGluIHRoZSBwbHVnaW4gc2V0dGluZ3MuXG4gICAqIFVwZGF0ZXMgdGhlIHBsdWdpbiBzZXR0aW5ncyB3aGVuIHRoZSB2YWx1ZSBjb21wb25lbnQncyB2YWx1ZSBjaGFuZ2VzLlxuICAgKlxuICAgKiBAdGVtcGxhdGUgVFZhbHVlQ29tcG9uZW50IC0gVGhlIHR5cGUgb2YgdGhlIHZhbHVlIGNvbXBvbmVudC5cbiAgICogQHRlbXBsYXRlIFByb3BlcnR5IC0gVGhlIHR5cGUgb2YgdGhlIHByb3BlcnR5IGluIHRoZSBwbHVnaW4gc2V0dGluZ3MgdGhhdCB0aGUgdmFsdWUgY29tcG9uZW50IGlzIGJvdW5kIHRvLlxuICAgKiBAcGFyYW0ge1RWYWx1ZUNvbXBvbmVudH0gdmFsdWVDb21wb25lbnQgLSBUaGUgdmFsdWUgY29tcG9uZW50IHRvIGJpbmQuXG4gICAqIEBwYXJhbSB7UGx1Z2luU2V0dGluZ3N9IHBsdWdpblNldHRpbmdzIC0gVGhlIHBsdWdpbiBzZXR0aW5ncyBvYmplY3QuXG4gICAqIEBwYXJhbSB7UHJvcGVydHl9IHByb3BlcnR5IC0gVGhlIHByb3BlcnR5IGluIHRoZSBwbHVnaW4gc2V0dGluZ3MgdG8gYmluZCB0aGUgdmFsdWUgY29tcG9uZW50IHRvLlxuICAgKiBAcGFyYW0ge2Jvb2xlYW59IFthdXRvU2F2ZT10cnVlXSAtIFdoZXRoZXIgdG8gYXV0b21hdGljYWxseSBzYXZlIHNldHRpbmdzIHdoZW4gdGhlIHZhbHVlIGNoYW5nZXMuXG4gICAqIEByZXR1cm5zIHtUVmFsdWVDb21wb25lbnR9IFRoZSBib3VuZCB2YWx1ZSBjb21wb25lbnQuXG4gICAqL1xuICBwcm90ZWN0ZWQgYmluZFZhbHVlQ29tcG9uZW50PFxuICAgIFRWYWx1ZUNvbXBvbmVudCBleHRlbmRzIFZhbHVlQ29tcG9uZW50PHVua25vd24+LFxuICAgIFByb3BlcnR5IGV4dGVuZHMgS2V5c01hdGNoaW5nPFBsdWdpblNldHRpbmdzLCBQcm9wZXJ0eVR5cGU+LFxuICAgIFByb3BlcnR5VHlwZSA9IFRWYWx1ZUNvbXBvbmVudCBleHRlbmRzIFZhbHVlQ29tcG9uZW50PGluZmVyIFA+ID8gUCA6IG5ldmVyLFxuICA+KFxuICAgIHZhbHVlQ29tcG9uZW50OiBUVmFsdWVDb21wb25lbnQsXG4gICAgcGx1Z2luU2V0dGluZ3M6IFBsdWdpblNldHRpbmdzLFxuICAgIHByb3BlcnR5OiBQcm9wZXJ0eSxcbiAgICBhdXRvU2F2ZTogYm9vbGVhbiA9IHRydWVcbiAgKTogVFZhbHVlQ29tcG9uZW50IHtcbiAgICB2YWx1ZUNvbXBvbmVudFxuICAgICAgLnNldFZhbHVlKHBsdWdpblNldHRpbmdzW3Byb3BlcnR5XSlcbiAgICAgIC5vbkNoYW5nZShhc3luYyAobmV3VmFsdWUpID0+IHtcbiAgICAgICAgcGx1Z2luU2V0dGluZ3NbcHJvcGVydHldID0gbmV3VmFsdWUgYXMgUGx1Z2luU2V0dGluZ3NbUHJvcGVydHldO1xuICAgICAgICBpZiAoYXV0b1NhdmUpIHtcbiAgICAgICAgICBhd2FpdCB0aGlzLnBsdWdpbi5zYXZlU2V0dGluZ3MocGx1Z2luU2V0dGluZ3MpO1xuICAgICAgICB9XG4gICAgICB9KTtcbiAgICByZXR1cm4gdmFsdWVDb21wb25lbnQ7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQVdBLHNCQUFpQztBQUNqQyx3QkFBMkI7QUFaM0IsTUFBTSxvQkFBb0IsV0FBVyxpQkFBaUIsTUFBTSxNQUFJLFFBQVEsVUFBVSxFQUFFLGNBQWMsVUFBVSxHQUFHO0FBQy9HLE1BQU0sWUFBWSxXQUFXLFNBQVMsS0FBSztBQUFBLEVBQ3pDLE9BQU8sTUFBSTtBQUFBLEVBQ1gsT0FBTyxDQUFDO0FBQUEsRUFDUixZQUFZO0FBQ2Q7QUFzQk8sTUFBZSw4QkFHWixpQ0FBaUI7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFNbEIsWUFBNEIsUUFBaUI7QUFDbEQsVUFBTSxPQUFPLEtBQUssTUFBTTtBQURTO0FBQUEsRUFFbkM7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQWNVLG1CQUtSLGdCQUNBLGdCQUNBLFVBQ0EsV0FBb0IsTUFDSDtBQUNqQixtQkFDRyxTQUFTLGVBQWUsUUFBUSxDQUFDLEVBQ2pDLFNBQVMsT0FBTyxhQUFhO0FBQzVCLHFCQUFlLFFBQVEsSUFBSTtBQUMzQixVQUFJLFVBQVU7QUFDWixjQUFNLEtBQUssT0FBTyxhQUFhLGNBQWM7QUFBQSxNQUMvQztBQUFBLElBQ0YsQ0FBQztBQUNILFdBQU87QUFBQSxFQUNUO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/obsidian/Plugin/PluginSettingsTabBase.ts"],
  "sourcesContent": ["const __import_meta_url = globalThis[\"import.meta.url\"] ?? (()=>require(\"node:url\").pathToFileURL(__filename))();\nconst __process = globalThis[\"process\"] ?? {\n  \"cwd\": ()=>\"/\",\n  \"env\": {},\n  \"platform\": \"android\"\n};\n/**\n * @file This module defines a base class for creating plugin setting tabs in Obsidian.\n * It provides a utility method to bind value components to plugin settings and handle changes.\n */\n\nimport { PluginSettingTab } from \"obsidian\";\nimport { PluginBase } from \"./PluginBase.ts\";\nimport type { KeysMatching } from \"../../@types.ts\";\n\ninterface ValueComponent<T> {\n  setValue(value: T): this;\n  onChange(callback: (newValue: T) => Promise<void>): this;\n}\n\n/**\n * Base class for creating plugin settings tabs in Obsidian.\n * Provides a method for binding value components to plugin settings and handling changes.\n *\n * @template TPlugin - The type of the plugin that extends PluginBase.\n * @template PluginSettings - The type of the plugin settings object.\n */\nexport abstract class PluginSettingsTabBase<\n  TPlugin extends PluginBase<PluginSettings>,\n  PluginSettings extends object\n> extends PluginSettingTab {\n  /**\n   * Creates an instance of PluginSettingsTabBase.\n   *\n   * @param {TPlugin} plugin - The plugin instance to which this settings tab belongs.\n   */\n  public constructor(public override plugin: TPlugin) {\n    super(plugin.app, plugin);\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 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 PropertyType - The inferred type of the property based on the value component's type.\n   *\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 component.\n   * @param options - Configuration options.\n   * @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.\n   *\n   * @returns The `TValueComponent` instance that was bound to the property.\n   */\n  protected bindValueComponent<\n    TValueComponent extends ValueComponent<unknown>,\n    Property extends KeysMatching<PluginSettings, UIValueType>,\n    UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never,\n  >(\n    valueComponent: TValueComponent,\n    property: Property,\n    options?: {\n      autoSave?: boolean\n    }\n  ): TValueComponent;\n\n  /**\n   * Binds a value component to a property in the plugin settings with automatic saving and custom value conversion.\n   *\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 UIValueType - The inferred type of the UI value based on the value component's type.\n   *\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 component.\n   * @param options - Configuration options.\n   * @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.\n   * @param options.settingToUIValueConverter - A function that converts the setting value to the value used by the UI component.\n   * @param options.uiToSettingValueConverter - A function that converts the UI component's value back to the setting value.\n   *\n   * @returns The `TValueComponent` instance that was bound to the property.\n   */\n  protected bindValueComponent<\n    TValueComponent extends ValueComponent<unknown>,\n    Property extends keyof PluginSettings,\n    UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never,\n  >(\n    valueComponent: TValueComponent,\n    property: Property,\n    options: {\n      autoSave?: boolean,\n      settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType,\n      uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property]\n    }\n  ): TValueComponent;\n\n  /**\n   * Internal implementation of `bindValueComponent` that handles both overloads.\n   *\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 UIValueType - The inferred type of the UI value based on the value component's type.\n   *\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 component.\n   * @param options - Configuration options.\n   * @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.\n   * @param options.settingToUIValueConverter - A function that converts the setting value to the value used by the UI component.\n   * @param options.uiToSettingValueConverter - A function that converts the UI component's value back to the setting value.\n   *\n   * @returns The `TValueComponent` instance that was bound to the property.\n   */\n  protected bindValueComponent<\n    TValueComponent extends ValueComponent<unknown>,\n    Property extends keyof PluginSettings,\n    UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never,\n  >(\n    valueComponent: TValueComponent,\n    property: Property,\n    {\n      autoSave,\n      settingToUIValueConverter,\n      uiToSettingValueConverter\n    }: {\n      autoSave?: boolean,\n      settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType,\n      uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property]\n    }\n  ): TValueComponent {\n    const pluginSettings = this.plugin.settingsCopy;\n    (valueComponent as ValueComponent<UIValueType>)\n      .setValue(settingToUIValueConverter(pluginSettings[property]))\n      .onChange(async (newValue) => {\n        pluginSettings[property] = uiToSettingValueConverter(newValue);\n        if (autoSave) {\n          await this.plugin.saveSettings(pluginSettings);\n        }\n      });\n    return valueComponent;\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAWA,sBAAiC;AACjC,wBAA2B;AAZ3B,MAAM,oBAAoB,WAAW,iBAAiB,MAAM,MAAI,QAAQ,UAAU,EAAE,cAAc,UAAU,GAAG;AAC/G,MAAM,YAAY,WAAW,SAAS,KAAK;AAAA,EACzC,OAAO,MAAI;AAAA,EACX,OAAO,CAAC;AAAA,EACR,YAAY;AACd;AAsBO,MAAe,8BAGZ,iCAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMlB,YAA4B,QAAiB;AAClD,UAAM,OAAO,KAAK,MAAM;AADS;AAAA,EAEnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0EU,mBAKR,gBACA,UACA;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAKiB;AACjB,UAAM,iBAAiB,KAAK,OAAO;AACnC,IAAC,eACE,SAAS,0BAA0B,eAAe,QAAQ,CAAC,CAAC,EAC5D,SAAS,OAAO,aAAa;AAC5B,qBAAe,QAAQ,IAAI,0BAA0B,QAAQ;AAC7D,UAAI,UAAU;AACZ,cAAM,KAAK,OAAO,aAAa,cAAc;AAAA,MAC/C;AAAA,IACF,CAAC;AACH,WAAO;AAAA,EACT;AACF;",
  "names": []
}


package/dist/lib/obsidian/Plugin/PluginSettingsTabBase.d.ts

@@ -25,17 +25,42 @@ export declare abstract class PluginSettingsTabBase<TPlugin extends PluginBase<P
      */
     constructor(plugin: TPlugin);
     /**
-     * Binds a value component to a specific property in the plugin settings.
-     * Updates the plugin settings when the value component's value changes.
+     * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.
      *
-     * @template TValueComponent - The type of the value component.
-     * @template Property - The type of the property in the plugin settings that the value component is bound to.
-     * @param {TValueComponent} valueComponent - The value component to bind.
-     * @param {PluginSettings} pluginSettings - The plugin settings object.
-     * @param {Property} property - The property in the plugin settings to bind the value component to.
-     * @param {boolean} [autoSave=true] - Whether to automatically save settings when the value changes.
-     * @returns {TValueComponent} The bound value component.
+     * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
+     * @typeParam Property - The key of the plugin setting that the component is bound to.
+     * @typeParam PropertyType - The inferred type of the property based on the value component's type.
+     *
+     * @param valueComponent - The component that will display and interact with the setting value.
+     * @param property - The property key in `PluginSettings` to bind to the component.
+     * @param options - Configuration options.
+     * @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.
+     *
+     * @returns The `TValueComponent` instance that was bound to the property.
+     */
+    protected bindValueComponent<TValueComponent extends ValueComponent<unknown>, Property extends KeysMatching<PluginSettings, UIValueType>, UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never>(valueComponent: TValueComponent, property: Property, options?: {
+        autoSave?: boolean;
+    }): TValueComponent;
+    /**
+     * Binds a value component to a property in the plugin settings with automatic saving and custom value conversion.
+     *
+     * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
+     * @typeParam Property - The key of the plugin setting that the component is bound to.
+     * @typeParam UIValueType - The inferred type of the UI value based on the value component's type.
+     *
+     * @param valueComponent - The component that will display and interact with the setting value.
+     * @param property - The property key in `PluginSettings` to bind to the component.
+     * @param options - Configuration options.
+     * @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.
+     * @param options.settingToUIValueConverter - A function that converts the setting value to the value used by the UI component.
+     * @param options.uiToSettingValueConverter - A function that converts the UI component's value back to the setting value.
+     *
+     * @returns The `TValueComponent` instance that was bound to the property.
      */
-    protected bindValueComponent<TValueComponent extends ValueComponent<unknown>, Property extends KeysMatching<PluginSettings, PropertyType>, PropertyType = TValueComponent extends ValueComponent<infer P> ? P : never>(valueComponent: TValueComponent, pluginSettings: PluginSettings, property: Property, autoSave?: boolean): TValueComponent;
+    protected bindValueComponent<TValueComponent extends ValueComponent<unknown>, Property extends keyof PluginSettings, UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never>(valueComponent: TValueComponent, property: Property, options: {
+        autoSave?: boolean;
+        settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType;
+        uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property];
+    }): TValueComponent;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-dev-utils",
-  "version": "1.6.0",
+  "version": "1.7.1",
   "description": "This is the collection of useful functions that you can use for your Obsidian plugin development",
   "main": "./dist/lib/index.cjs",
   "types": "./dist/lib/index.d.ts",