@mnaoumov/obsidian-lib 0.0.0 → 1.0.0

package/dist/lib/cjs/setting-components/text-based-component.d.cts

@@ -0,0 +1,38 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Text based component utilities.
+ */
+/**
+ * A component based on a text input.
+ *
+ * @typeParam T - The type of the value to set.
+ */
+export interface TextBasedComponent<T> {
+    /**
+     * Empties the component.
+     */
+    empty: () => void;
+    /**
+     * Checks if the component is empty.
+     *
+     * @returns `true` if the component is empty, `false` otherwise.
+     */
+    isEmpty: () => boolean;
+    /**
+     * Sets the placeholder value of the component.
+     *
+     * @param placeholderValue - The placeholder value to set.
+     * @returns The component.
+     */
+    setPlaceholderValue: (placeholderValue: T) => this;
+}
+/**
+ * Gets the text based component value of the component.
+ *
+ * @typeParam T - The type of the value to get.
+ * @param $unknown - Any object.
+ * @returns The text based component value of the component or `null` if the component is not a text based component.
+ */
+export declare function getTextBasedComponentValue<T>($unknown: unknown): null | TextBasedComponent<T>;

package/dist/lib/cjs/setting-components/time-component.cjs

@@ -0,0 +1,209 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for('Symbol.asyncDispose');
+  symbolConstructor.dispose ??= symbolConstructor.for('Symbol.dispose');
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  // eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+function keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord['__name'] ??= keepName;
+  globalThisRecord['__extractDefault'] ??= extractDefault;
+
+  ensureBrowserProcess();
+
+  // eslint-disable-next-line unicorn/consistent-function-scoping -- Serialized with initCjs into the banner; at module scope it would be left out of it.
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+
+  // eslint-disable-next-line no-global-assign, no-implicit-globals -- We need to patch the `require()` function.
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/autocomplete',
+  '@codemirror/collab',
+  '@codemirror/commands',
+  '@codemirror/language',
+  '@codemirror/lint',
+  '@codemirror/search',
+  '@codemirror/state',
+  '@codemirror/text',
+  '@codemirror/view',
+  '@lezer/common',
+  '@lezer/highlight',
+  '@lezer/lr',
+  'obsidian']
+  );
+
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/closebrackets',
+  '@codemirror/comment',
+  '@codemirror/fold',
+  '@codemirror/gutter',
+  '@codemirror/highlight',
+  '@codemirror/history',
+  '@codemirror/matchbrackets',
+  '@codemirror/panel',
+  '@codemirror/rangeset',
+  '@codemirror/rectangular-selection',
+  '@codemirror/stream-parser',
+  '@codemirror/tooltip']
+  );
+
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this  -- Need access to app. Actively use globalThis.
+    if (globalThis.app.isMobile) {
+      if (id === 'process' || id === 'node:process') {
+        // eslint-disable-next-line no-console -- Valid usage.
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+
+    // eslint-disable-next-line no-console -- Valid usage.
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var time_component_exports = {};
+__export(time_component_exports, {
+  TimeComponent: () => TimeComponent
+});
+module.exports = __toCommonJS(time_component_exports);
+var import_obsidian = require('obsidian');
+var import_css_class = require('../css-class.cjs');
+var import_typed_range_text_component = require('./typed-range-text-component.cjs');
+class TimeComponent extends import_typed_range_text_component.TypedRangeTextComponent {
+  /**
+   * Creates a new time component.
+   *
+   * @param containerEl - The container element of the component.
+   */
+  constructor(containerEl) {
+    super({
+      containerEl,
+      cssClass: import_css_class.CssClass.TimeComponent,
+      type: "time"
+    });
+  }
+  /**
+   * Converts a string to a time.
+   *
+   * @param $string - The string to convert.
+   * @returns The date.
+   */
+  valueFromString($string) {
+    return import_obsidian.moment.duration($string);
+  }
+  /**
+   * Converts a time to a string.
+   *
+   * @param value - The time to convert.
+   * @returns The string.
+   */
+  valueToString(value) {
+    let format;
+    if (value.milliseconds() > 0) {
+      format = "HH:mm:ss.SSS";
+    } else if (value.seconds() > 0) {
+      format = "HH:mm:ss";
+    } else {
+      format = "HH:mm";
+    }
+    return import_obsidian.moment.utc(value.asMilliseconds()).format(format);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TimeComponent
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL3NldHRpbmctY29tcG9uZW50cy90aW1lLWNvbXBvbmVudC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIENvbnRhaW5zIGEgY29tcG9uZW50IHRoYXQgZGlzcGxheXMgYW5kIGVkaXRzIGEgdGltZS5cbiAqL1xuXG5pbXBvcnQgeyBtb21lbnQgfSBmcm9tICdvYnNpZGlhbic7XG5cbi8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdW51c2VkLXZhcnMgLS0gV2UgbmVlZCB0byBpbXBvcnQgYGluaXRQbHVnaW5Db250ZXh0YCB0byB1c2UgaXQgaW4gdGhlIHRzZG9jcy5cbmltcG9ydCB0eXBlIHsgaW5pdFBsdWdpbkNvbnRleHQgfSBmcm9tICcuLi9wbHVnaW4vcGx1Z2luLWNvbnRleHQudHMnO1xuLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby11bnVzZWQtdmFycyAtLSBXZSBuZWVkIHRvIGltcG9ydCBgU2V0dGluZ0V4YCB0byB1c2UgaXQgaW4gdGhlIHRzZG9jcy5cbmltcG9ydCB0eXBlIHsgU2V0dGluZ0V4IH0gZnJvbSAnLi4vc2V0dGluZy1leC50cyc7XG5cbmltcG9ydCB7IENzc0NsYXNzIH0gZnJvbSAnLi4vY3NzLWNsYXNzLnRzJztcbmltcG9ydCB7IFR5cGVkUmFuZ2VUZXh0Q29tcG9uZW50IH0gZnJvbSAnLi90eXBlZC1yYW5nZS10ZXh0LWNvbXBvbmVudC50cyc7XG5cbi8qKlxuICogQSBjb21wb25lbnQgdGhhdCBkaXNwbGF5cyBhbmQgZWRpdHMgYSB0aW1lLlxuICpcbiAqIFlvdSBjYW4gYWRkIHRoaXMgY29tcG9uZW50IHVzaW5nIHtAbGluayBTZXR0aW5nRXguYWRkVGltZX0uXG4gKlxuICogSW4gb3JkZXIgdG8gYWRkIHRoZSBzdHlsZXMgZm9yIHRoZSBjb21wb25lbnQsIHVzZSB7QGxpbmsgaW5pdFBsdWdpbkNvbnRleHR9IGluIHlvdXIgcGx1Z2luJ3MgYG9ubG9hZCgpYCBmdW5jdGlvbi5cbiAqXG4gKiBBbHRlcm5hdGl2ZWx5LCB5b3UgY2FuIGNvcHkgc3R5bGVzIGZyb20ge0BsaW5rIGh0dHBzOi8vZ2l0aHViLmNvbS9tbmFvdW1vdi9vYnNpZGlhbi1kZXYtdXRpbHMvcmVsZWFzZXMvbGF0ZXN0L2Rvd25sb2FkL3N0eWxlcy5jc3N9LlxuICovXG5leHBvcnQgY2xhc3MgVGltZUNvbXBvbmVudCBleHRlbmRzIFR5cGVkUmFuZ2VUZXh0Q29tcG9uZW50PG1vbWVudC5EdXJhdGlvbj4ge1xuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyB0aW1lIGNvbXBvbmVudC5cbiAgICpcbiAgICogQHBhcmFtIGNvbnRhaW5lckVsIC0gVGhlIGNvbnRhaW5lciBlbGVtZW50IG9mIHRoZSBjb21wb25lbnQuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IoY29udGFpbmVyRWw6IEhUTUxFbGVtZW50KSB7XG4gICAgc3VwZXIoe1xuICAgICAgY29udGFpbmVyRWwsXG4gICAgICBjc3NDbGFzczogQ3NzQ2xhc3MuVGltZUNvbXBvbmVudCxcbiAgICAgIHR5cGU6ICd0aW1lJ1xuICAgIH0pO1xuICB9XG5cbiAgLyoqXG4gICAqIENvbnZlcnRzIGEgc3RyaW5nIHRvIGEgdGltZS5cbiAgICpcbiAgICogQHBhcmFtICRzdHJpbmcgLSBUaGUgc3RyaW5nIHRvIGNvbnZlcnQuXG4gICAqIEByZXR1cm5zIFRoZSBkYXRlLlxuICAgKi9cbiAgcHVibGljIG92ZXJyaWRlIHZhbHVlRnJvbVN0cmluZygkc3RyaW5nOiBzdHJpbmcpOiBtb21lbnQuRHVyYXRpb24ge1xuICAgIHJldHVybiBtb21lbnQuZHVyYXRpb24oJHN0cmluZyk7XG4gIH1cblxuICAvKipcbiAgICogQ29udmVydHMgYSB0aW1lIHRvIGEgc3RyaW5nLlxuICAgKlxuICAgKiBAcGFyYW0gdmFsdWUgLSBUaGUgdGltZSB0byBjb252ZXJ0LlxuICAgKiBAcmV0dXJucyBUaGUgc3RyaW5nLlxuICAgKi9cbiAgcHVibGljIG92ZXJyaWRlIHZhbHVlVG9TdHJpbmcodmFsdWU6IG1vbWVudC5EdXJhdGlvbik6IHN0cmluZyB7XG4gICAgbGV0IGZvcm1hdDogc3RyaW5nO1xuICAgIGlmICh2YWx1ZS5taWxsaXNlY29uZHMoKSA+IDApIHtcbiAgICAgIGZvcm1hdCA9ICdISDptbTpzcy5TU1MnO1xuICAgIH0gZWxzZSBpZiAodmFsdWUuc2Vjb25kcygpID4gMCkge1xuICAgICAgZm9ybWF0ID0gJ0hIOm1tOnNzJztcbiAgICB9IGVsc2Uge1xuICAgICAgZm9ybWF0ID0gJ0hIOm1tJztcbiAgICB9XG5cbiAgICByZXR1cm4gbW9tZW50LnV0Yyh2YWx1ZS5hc01pbGxpc2Vjb25kcygpKS5mb3JtYXQoZm9ybWF0KTtcbiAgfVxufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQU1BLHNCQUF1QjtBQU92Qix1QkFBeUI7QUFDekIsd0NBQXdDO0FBV2pDLE1BQU0sc0JBQXNCLDBEQUF5QztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU1uRSxZQUFZLGFBQTBCO0FBQzNDLFVBQU07QUFBQSxNQUNKO0FBQUEsTUFDQSxVQUFVLDBCQUFTO0FBQUEsTUFDbkIsTUFBTTtBQUFBLElBQ1IsQ0FBQztBQUFBLEVBQ0g7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVFnQixnQkFBZ0IsU0FBa0M7QUFDaEUsV0FBTyx1QkFBTyxTQUFTLE9BQU87QUFBQSxFQUNoQztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUWdCLGNBQWMsT0FBZ0M7QUFDNUQsUUFBSTtBQUNKLFFBQUksTUFBTSxhQUFhLElBQUksR0FBRztBQUM1QixlQUFTO0FBQUEsSUFDWCxXQUFXLE1BQU0sUUFBUSxJQUFJLEdBQUc7QUFDOUIsZUFBUztBQUFBLElBQ1gsT0FBTztBQUNMLGVBQVM7QUFBQSxJQUNYO0FBRUEsV0FBTyx1QkFBTyxJQUFJLE1BQU0sZUFBZSxDQUFDLEVBQUUsT0FBTyxNQUFNO0FBQUEsRUFDekQ7QUFDRjsiLAogICJuYW1lcyI6IFtdCn0K

package/dist/lib/cjs/setting-components/time-component.d.cts

@@ -0,0 +1,38 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Contains a component that displays and edits a time.
+ */
+import { TypedRangeTextComponent } from './typed-range-text-component.cjs';
+/**
+ * A component that displays and edits a time.
+ *
+ * You can add this component using {@link SettingEx.addTime}.
+ *
+ * In order to add the styles for the component, use {@link initPluginContext} in your plugin's `onload()` function.
+ *
+ * Alternatively, you can copy styles from {@link https://github.com/mnaoumov/obsidian-dev-utils/releases/latest/download/styles.css}.
+ */
+export declare class TimeComponent extends TypedRangeTextComponent<moment.Duration> {
+    /**
+     * Creates a new time component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to a time.
+     *
+     * @param $string - The string to convert.
+     * @returns The date.
+     */
+    valueFromString($string: string): moment.Duration;
+    /**
+     * Converts a time to a string.
+     *
+     * @param value - The time to convert.
+     * @returns The string.
+     */
+    valueToString(value: moment.Duration): string;
+}

package/dist/lib/cjs/setting-components/tri-state-checkbox-component.cjs

@@ -0,0 +1,241 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for('Symbol.asyncDispose');
+  symbolConstructor.dispose ??= symbolConstructor.for('Symbol.dispose');
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  // eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+function keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord['__name'] ??= keepName;
+  globalThisRecord['__extractDefault'] ??= extractDefault;
+
+  ensureBrowserProcess();
+
+  // eslint-disable-next-line unicorn/consistent-function-scoping -- Serialized with initCjs into the banner; at module scope it would be left out of it.
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+
+  // eslint-disable-next-line no-global-assign, no-implicit-globals -- We need to patch the `require()` function.
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/autocomplete',
+  '@codemirror/collab',
+  '@codemirror/commands',
+  '@codemirror/language',
+  '@codemirror/lint',
+  '@codemirror/search',
+  '@codemirror/state',
+  '@codemirror/text',
+  '@codemirror/view',
+  '@lezer/common',
+  '@lezer/highlight',
+  '@lezer/lr',
+  'obsidian']
+  );
+
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/closebrackets',
+  '@codemirror/comment',
+  '@codemirror/fold',
+  '@codemirror/gutter',
+  '@codemirror/highlight',
+  '@codemirror/history',
+  '@codemirror/matchbrackets',
+  '@codemirror/panel',
+  '@codemirror/rangeset',
+  '@codemirror/rectangular-selection',
+  '@codemirror/stream-parser',
+  '@codemirror/tooltip']
+  );
+
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this  -- Need access to app. Actively use globalThis.
+    if (globalThis.app.isMobile) {
+      if (id === 'process' || id === 'node:process') {
+        // eslint-disable-next-line no-console -- Valid usage.
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+
+    // eslint-disable-next-line no-console -- Valid usage.
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var tri_state_checkbox_component_exports = {};
+__export(tri_state_checkbox_component_exports, {
+  TriStateCheckboxComponent: () => TriStateCheckboxComponent
+});
+module.exports = __toCommonJS(tri_state_checkbox_component_exports);
+var import_obsidian = require('obsidian');
+var import_css_class = require('../css-class.cjs');
+var import_plugin_context = require('../plugin/plugin-context.cjs');
+class TriStateCheckboxComponent extends import_obsidian.ValueComponent {
+  /**
+   * An input element of the checkbox.
+   */
+  inputEl;
+  /**
+   * A validator element of the checkbox.
+   *
+   * @returns The validator element.
+   */
+  get validatorEl() {
+    return this.inputEl;
+  }
+  changeCallback;
+  /**
+   * Creates a new tri-state checkbox component.
+   *
+   * @param containerEl - The container element.
+   */
+  constructor(containerEl) {
+    super();
+    (0, import_plugin_context.addPluginCssClasses)(containerEl, import_css_class.CssClass.TriStateCheckboxComponent);
+    this.inputEl = containerEl.createEl("input", { type: "checkbox" });
+    this.inputEl.addEventListener("change", this.onChanged.bind(this));
+  }
+  /**
+   * Gets the value of the checkbox.
+   *
+   * @returns The value of the checkbox.
+   */
+  getValue() {
+    return this.inputEl.indeterminate ? null : this.inputEl.checked;
+  }
+  /**
+   * Sets the callback to be called when the checkbox is changed.
+   *
+   * @param callback - The callback to be called when the checkbox is changed.
+   * @returns The component.
+   */
+  onChange(callback) {
+    this.changeCallback = callback;
+    return this;
+  }
+  /**
+   * Called when the checkbox is changed.
+   */
+  onChanged() {
+    this.changeCallback?.(this.getValue());
+  }
+  /**
+   * Sets the disabled state of the checkbox.
+   *
+   * @param isDisabled - The disabled state of the checkbox.
+   * @returns The component.
+   */
+  setDisabled(isDisabled) {
+    super.setDisabled(isDisabled);
+    this.inputEl.disabled = isDisabled;
+    return this;
+  }
+  /**
+   * Sets the value of the checkbox.
+   *
+   * @param value - The value to set the checkbox to.
+   * @returns The component.
+   */
+  setValue(value) {
+    this.inputEl.indeterminate = value === null;
+    this.inputEl.checked = value ?? false;
+    return this;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TriStateCheckboxComponent
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL3NldHRpbmctY29tcG9uZW50cy90cmktc3RhdGUtY2hlY2tib3gtY29tcG9uZW50LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogVHJpLXN0YXRlIGNoZWNrYm94IGNvbXBvbmVudC5cbiAqL1xuXG5pbXBvcnQgdHlwZSB7IFZhbGlkYXRvckVsZW1lbnQgfSBmcm9tICdAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWIvaHRtbC1lbGVtZW50JztcblxuaW1wb3J0IHsgVmFsdWVDb21wb25lbnQgfSBmcm9tICdvYnNpZGlhbic7XG5cbi8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdW51c2VkLXZhcnMgLS0gV2UgbmVlZCB0byBpbXBvcnQgYGluaXRQbHVnaW5Db250ZXh0YCB0byB1c2UgaXQgaW4gdGhlIHRzZG9jcy5cbmltcG9ydCB0eXBlIHsgaW5pdFBsdWdpbkNvbnRleHQgfSBmcm9tICcuLi9wbHVnaW4vcGx1Z2luLWNvbnRleHQudHMnO1xuLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby11bnVzZWQtdmFycyAtLSBXZSBuZWVkIHRvIGltcG9ydCBgU2V0dGluZ0V4YCB0byB1c2UgaXQgaW4gdGhlIHRzZG9jcy5cbmltcG9ydCB0eXBlIHsgU2V0dGluZ0V4IH0gZnJvbSAnLi4vc2V0dGluZy1leC50cyc7XG5pbXBvcnQgdHlwZSB7IFZhbGlkYXRvckNvbXBvbmVudCB9IGZyb20gJy4vdmFsaWRhdG9yLWNvbXBvbmVudC50cyc7XG5pbXBvcnQgdHlwZSB7IFZhbHVlQ29tcG9uZW50V2l0aENoYW5nZVRyYWNraW5nIH0gZnJvbSAnLi92YWx1ZS1jb21wb25lbnQtd2l0aC1jaGFuZ2UtdHJhY2tpbmcudHMnO1xuXG5pbXBvcnQgeyBDc3NDbGFzcyB9IGZyb20gJy4uL2Nzcy1jbGFzcy50cyc7XG5pbXBvcnQgeyBhZGRQbHVnaW5Dc3NDbGFzc2VzIH0gZnJvbSAnLi4vcGx1Z2luL3BsdWdpbi1jb250ZXh0LnRzJztcblxuLyoqXG4gKiBBIGNvbXBvbmVudCB0aGF0IGRpc3BsYXlzIGEgdHJpLXN0YXRlIGNoZWNrYm94LlxuICpcbiAqIFlvdSBjYW4gYWRkIHRoaXMgY29tcG9uZW50IHVzaW5nIHtAbGluayBTZXR0aW5nRXguYWRkVHJpU3RhdGVDaGVja2JveH0uXG4gKlxuICogSW4gb3JkZXIgdG8gYWRkIHRoZSBzdHlsZXMgZm9yIHRoZSBjb21wb25lbnQsIHVzZSB7QGxpbmsgaW5pdFBsdWdpbkNvbnRleHR9IGluIHlvdXIgcGx1Z2luJ3MgYG9ubG9hZCgpYCBmdW5jdGlvbi5cbiAqXG4gKiBBbHRlcm5hdGl2ZWx5LCB5b3UgY2FuIGNvcHkgc3R5bGVzIGZyb20ge0BsaW5rIGh0dHBzOi8vZ2l0aHViLmNvbS9tbmFvdW1vdi9vYnNpZGlhbi1kZXYtdXRpbHMvcmVsZWFzZXMvbGF0ZXN0L2Rvd25sb2FkL3N0eWxlcy5jc3N9LlxuICovXG5leHBvcnQgY2xhc3MgVHJpU3RhdGVDaGVja2JveENvbXBvbmVudCBleHRlbmRzIFZhbHVlQ29tcG9uZW50PGJvb2xlYW4gfCBudWxsPiBpbXBsZW1lbnRzIFZhbGlkYXRvckNvbXBvbmVudCwgVmFsdWVDb21wb25lbnRXaXRoQ2hhbmdlVHJhY2tpbmc8Ym9vbGVhbiB8IG51bGw+IHtcbiAgLyoqXG4gICAqIEFuIGlucHV0IGVsZW1lbnQgb2YgdGhlIGNoZWNrYm94LlxuICAgKi9cbiAgcHVibGljIHJlYWRvbmx5IGlucHV0RWw6IEhUTUxJbnB1dEVsZW1lbnQ7XG5cbiAgLyoqXG4gICAqIEEgdmFsaWRhdG9yIGVsZW1lbnQgb2YgdGhlIGNoZWNrYm94LlxuICAgKlxuICAgKiBAcmV0dXJucyBUaGUgdmFsaWRhdG9yIGVsZW1lbnQuXG4gICAqL1xuICBwdWJsaWMgZ2V0IHZhbGlkYXRvckVsKCk6IFZhbGlkYXRvckVsZW1lbnQge1xuICAgIHJldHVybiB0aGlzLmlucHV0RWw7XG4gIH1cblxuICBwcml2YXRlIGNoYW5nZUNhbGxiYWNrPzogKG5ld1ZhbHVlOiBib29sZWFuIHwgbnVsbCkgPT4gdm9pZDtcblxuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyB0cmktc3RhdGUgY2hlY2tib3ggY29tcG9uZW50LlxuICAgKlxuICAgKiBAcGFyYW0gY29udGFpbmVyRWwgLSBUaGUgY29udGFpbmVyIGVsZW1lbnQuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IoY29udGFpbmVyRWw6IEhUTUxFbGVtZW50KSB7XG4gICAgc3VwZXIoKTtcbiAgICBhZGRQbHVnaW5Dc3NDbGFzc2VzKGNvbnRhaW5lckVsLCBDc3NDbGFzcy5UcmlTdGF0ZUNoZWNrYm94Q29tcG9uZW50KTtcbiAgICB0aGlzLmlucHV0RWwgPSBjb250YWluZXJFbC5jcmVhdGVFbCgnaW5wdXQnLCB7IHR5cGU6ICdjaGVja2JveCcgfSk7XG4gICAgdGhpcy5pbnB1dEVsLmFkZEV2ZW50TGlzdGVuZXIoJ2NoYW5nZScsIHRoaXMub25DaGFuZ2VkLmJpbmQodGhpcykpO1xuICB9XG5cbiAgLyoqXG4gICAqIEdldHMgdGhlIHZhbHVlIG9mIHRoZSBjaGVja2JveC5cbiAgICpcbiAgICogQHJldHVybnMgVGhlIHZhbHVlIG9mIHRoZSBjaGVja2JveC5cbiAgICovXG4gIHB1YmxpYyBvdmVycmlkZSBnZXRWYWx1ZSgpOiBib29sZWFuIHwgbnVsbCB7XG4gICAgcmV0dXJuIHRoaXMuaW5wdXRFbC5pbmRldGVybWluYXRlID8gbnVsbCA6IHRoaXMuaW5wdXRFbC5jaGVja2VkO1xuICB9XG5cbiAgLyoqXG4gICAqIFNldHMgdGhlIGNhbGxiYWNrIHRvIGJlIGNhbGxlZCB3aGVuIHRoZSBjaGVja2JveCBpcyBjaGFuZ2VkLlxuICAgKlxuICAgKiBAcGFyYW0gY2FsbGJhY2sgLSBUaGUgY2FsbGJhY2sgdG8gYmUgY2FsbGVkIHdoZW4gdGhlIGNoZWNrYm94IGlzIGNoYW5nZWQuXG4gICAqIEByZXR1cm5zIFRoZSBjb21wb25lbnQuXG4gICAqL1xuICBwdWJsaWMgb25DaGFuZ2UoY2FsbGJhY2s6IChuZXdWYWx1ZTogYm9vbGVhbiB8IG51bGwpID0+IHZvaWQpOiB0aGlzIHtcbiAgICB0aGlzLmNoYW5nZUNhbGxiYWNrID0gY2FsbGJhY2s7XG4gICAgcmV0dXJuIHRoaXM7XG4gIH1cblxuICAvKipcbiAgICogQ2FsbGVkIHdoZW4gdGhlIGNoZWNrYm94IGlzIGNoYW5nZWQuXG4gICAqL1xuICBwdWJsaWMgb25DaGFuZ2VkKCk6IHZvaWQge1xuICAgIHRoaXMuY2hhbmdlQ2FsbGJhY2s/Lih0aGlzLmdldFZhbHVlKCkpO1xuICB9XG5cbiAgLyoqXG4gICAqIFNldHMgdGhlIGRpc2FibGVkIHN0YXRlIG9mIHRoZSBjaGVja2JveC5cbiAgICpcbiAgICogQHBhcmFtIGlzRGlzYWJsZWQgLSBUaGUgZGlzYWJsZWQgc3RhdGUgb2YgdGhlIGNoZWNrYm94LlxuICAgKiBAcmV0dXJucyBUaGUgY29tcG9uZW50LlxuICAgKi9cbiAgcHVibGljIG92ZXJyaWRlIHNldERpc2FibGVkKGlzRGlzYWJsZWQ6IGJvb2xlYW4pOiB0aGlzIHtcbiAgICBzdXBlci5zZXREaXNhYmxlZChpc0Rpc2FibGVkKTtcbiAgICB0aGlzLmlucHV0RWwuZGlzYWJsZWQgPSBpc0Rpc2FibGVkO1xuICAgIHJldHVybiB0aGlzO1xuICB9XG5cbiAgLyoqXG4gICAqIFNldHMgdGhlIHZhbHVlIG9mIHRoZSBjaGVja2JveC5cbiAgICpcbiAgICogQHBhcmFtIHZhbHVlIC0gVGhlIHZhbHVlIHRvIHNldCB0aGUgY2hlY2tib3ggdG8uXG4gICAqIEByZXR1cm5zIFRoZSBjb21wb25lbnQuXG4gICAqL1xuICBwdWJsaWMgb3ZlcnJpZGUgc2V0VmFsdWUodmFsdWU6IGJvb2xlYW4gfCBudWxsKTogdGhpcyB7XG4gICAgdGhpcy5pbnB1dEVsLmluZGV0ZXJtaW5hdGUgPSB2YWx1ZSA9PT0gbnVsbDtcbiAgICB0aGlzLmlucHV0RWwuY2hlY2tlZCA9IHZhbHVlID8/IGZhbHNlO1xuICAgIHJldHVybiB0aGlzO1xuICB9XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBUUEsc0JBQStCO0FBUy9CLHVCQUF5QjtBQUN6Qiw0QkFBb0M7QUFXN0IsTUFBTSxrQ0FBa0MsK0JBQStHO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFJNUk7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPaEIsSUFBVyxjQUFnQztBQUN6QyxXQUFPLEtBQUs7QUFBQSxFQUNkO0FBQUEsRUFFUTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9ELFlBQVksYUFBMEI7QUFDM0MsVUFBTTtBQUNOLG1EQUFvQixhQUFhLDBCQUFTLHlCQUF5QjtBQUNuRSxTQUFLLFVBQVUsWUFBWSxTQUFTLFNBQVMsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUNqRSxTQUFLLFFBQVEsaUJBQWlCLFVBQVUsS0FBSyxVQUFVLEtBQUssSUFBSSxDQUFDO0FBQUEsRUFDbkU7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPZ0IsV0FBMkI7QUFDekMsV0FBTyxLQUFLLFFBQVEsZ0JBQWdCLE9BQU8sS0FBSyxRQUFRO0FBQUEsRUFDMUQ7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVFPLFNBQVMsVUFBb0Q7QUFDbEUsU0FBSyxpQkFBaUI7QUFDdEIsV0FBTztBQUFBLEVBQ1Q7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQUtPLFlBQWtCO0FBQ3ZCLFNBQUssaUJBQWlCLEtBQUssU0FBUyxDQUFDO0FBQUEsRUFDdkM7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVFnQixZQUFZLFlBQTJCO0FBQ3JELFVBQU0sWUFBWSxVQUFVO0FBQzVCLFNBQUssUUFBUSxXQUFXO0FBQ3hCLFdBQU87QUFBQSxFQUNUO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFRZ0IsU0FBUyxPQUE2QjtBQUNwRCxTQUFLLFFBQVEsZ0JBQWdCLFVBQVU7QUFDdkMsU0FBSyxRQUFRLFVBQVUsU0FBUztBQUNoQyxXQUFPO0FBQUEsRUFDVDtBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/cjs/setting-components/tri-state-checkbox-component.d.cts

@@ -0,0 +1,69 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Tri-state checkbox component.
+ */
+import type { ValidatorElement } from '@mnaoumov/typescript-lib/html-element' with { 'resolution-mode': 'import' };
+import { ValueComponent } from 'obsidian';
+import type { ValidatorComponent } from './validator-component.cjs';
+import type { ValueComponentWithChangeTracking } from './value-component-with-change-tracking.cjs';
+/**
+ * A component that displays a tri-state checkbox.
+ *
+ * You can add this component using {@link SettingEx.addTriStateCheckbox}.
+ *
+ * In order to add the styles for the component, use {@link initPluginContext} in your plugin's `onload()` function.
+ *
+ * Alternatively, you can copy styles from {@link https://github.com/mnaoumov/obsidian-dev-utils/releases/latest/download/styles.css}.
+ */
+export declare class TriStateCheckboxComponent extends ValueComponent<boolean | null> implements ValidatorComponent, ValueComponentWithChangeTracking<boolean | null> {
+    /**
+     * An input element of the checkbox.
+     */
+    readonly inputEl: HTMLInputElement;
+    /**
+     * A validator element of the checkbox.
+     *
+     * @returns The validator element.
+     */
+    get validatorEl(): ValidatorElement;
+    private changeCallback?;
+    /**
+     * Creates a new tri-state checkbox component.
+     *
+     * @param containerEl - The container element.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Gets the value of the checkbox.
+     *
+     * @returns The value of the checkbox.
+     */
+    getValue(): boolean | null;
+    /**
+     * Sets the callback to be called when the checkbox is changed.
+     *
+     * @param callback - The callback to be called when the checkbox is changed.
+     * @returns The component.
+     */
+    onChange(callback: (newValue: boolean | null) => void): this;
+    /**
+     * Called when the checkbox is changed.
+     */
+    onChanged(): void;
+    /**
+     * Sets the disabled state of the checkbox.
+     *
+     * @param isDisabled - The disabled state of the checkbox.
+     * @returns The component.
+     */
+    setDisabled(isDisabled: boolean): this;
+    /**
+     * Sets the value of the checkbox.
+     *
+     * @param value - The value to set the checkbox to.
+     * @returns The component.
+     */
+    setValue(value: boolean | null): this;
+}