@mnaoumov/obsidian-lib 0.0.0 → 1.0.0

package/dist/lib/esm/resource-url.d.mts

@@ -0,0 +1,31 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * This module provides utility functions for working with resource URLs in Obsidian.
+ */
+import type { App } from 'obsidian';
+/**
+ * Parameters for {@link relativePathToResourceUrl}.
+ */
+export interface RelativePathToResourceUrlParams {
+    /**
+     * The Obsidian application instance.
+     */
+    readonly app: App;
+    /**
+     * The path of the note.
+     */
+    readonly notePath: string;
+    /**
+     * The relative path to the resource.
+     */
+    readonly relativePath: string;
+}
+/**
+ * Converts a relative path to a resource URL.
+ *
+ * @param params - The parameters for the conversion.
+ * @returns The resource URL.
+ */
+export declare function relativePathToResourceUrl(params: RelativePathToResourceUrlParams): string;

package/dist/lib/esm/resource-url.mjs

@@ -0,0 +1,67 @@
+/*
+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 initEsm() {
+  ensureDisposeSymbols();
+  ensureBrowserProcess();
+})();
+})();
+
+import { toPosixPath } from "@mnaoumov/typescript-lib/path";
+import { getDataAdapterEx } from "@obsidian-typings/obsidian-public-latest/implementations";
+import { Platform } from "obsidian";
+function relativePathToResourceUrl(params) {
+  const {
+    app,
+    notePath,
+    relativePath
+  } = params;
+  const noteFullPath = toPosixPath(getDataAdapterEx(app).getFullRealPath(notePath));
+  const noteUrl = `${Platform.resourcePathPrefix}${noteFullPath}`;
+  const relativeUrl = new URL(relativePath, noteUrl);
+  return relativeUrl.href;
+}
+export {
+  relativePathToResourceUrl
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL3Jlc291cmNlLXVybC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIFRoaXMgbW9kdWxlIHByb3ZpZGVzIHV0aWxpdHkgZnVuY3Rpb25zIGZvciB3b3JraW5nIHdpdGggcmVzb3VyY2UgVVJMcyBpbiBPYnNpZGlhbi5cbiAqL1xuXG5pbXBvcnQgdHlwZSB7IEFwcCB9IGZyb20gJ29ic2lkaWFuJztcblxuaW1wb3J0IHsgdG9Qb3NpeFBhdGggfSBmcm9tICdAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWIvcGF0aCc7XG5pbXBvcnQgeyBnZXREYXRhQWRhcHRlckV4IH0gZnJvbSAnQG9ic2lkaWFuLXR5cGluZ3Mvb2JzaWRpYW4tcHVibGljLWxhdGVzdC9pbXBsZW1lbnRhdGlvbnMnO1xuaW1wb3J0IHsgUGxhdGZvcm0gfSBmcm9tICdvYnNpZGlhbic7XG5cbi8qKlxuICogUGFyYW1ldGVycyBmb3Ige0BsaW5rIHJlbGF0aXZlUGF0aFRvUmVzb3VyY2VVcmx9LlxuICovXG5leHBvcnQgaW50ZXJmYWNlIFJlbGF0aXZlUGF0aFRvUmVzb3VyY2VVcmxQYXJhbXMge1xuICAvKipcbiAgICogVGhlIE9ic2lkaWFuIGFwcGxpY2F0aW9uIGluc3RhbmNlLlxuICAgKi9cbiAgcmVhZG9ubHkgYXBwOiBBcHA7XG5cbiAgLyoqXG4gICAqIFRoZSBwYXRoIG9mIHRoZSBub3RlLlxuICAgKi9cbiAgcmVhZG9ubHkgbm90ZVBhdGg6IHN0cmluZztcblxuICAvKipcbiAgICogVGhlIHJlbGF0aXZlIHBhdGggdG8gdGhlIHJlc291cmNlLlxuICAgKi9cbiAgcmVhZG9ubHkgcmVsYXRpdmVQYXRoOiBzdHJpbmc7XG59XG5cbi8qKlxuICogQ29udmVydHMgYSByZWxhdGl2ZSBwYXRoIHRvIGEgcmVzb3VyY2UgVVJMLlxuICpcbiAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgcGFyYW1ldGVycyBmb3IgdGhlIGNvbnZlcnNpb24uXG4gKiBAcmV0dXJucyBUaGUgcmVzb3VyY2UgVVJMLlxuICovXG5leHBvcnQgZnVuY3Rpb24gcmVsYXRpdmVQYXRoVG9SZXNvdXJjZVVybChwYXJhbXM6IFJlbGF0aXZlUGF0aFRvUmVzb3VyY2VVcmxQYXJhbXMpOiBzdHJpbmcge1xuICBjb25zdCB7XG4gICAgYXBwLFxuICAgIG5vdGVQYXRoLFxuICAgIHJlbGF0aXZlUGF0aFxuICB9ID0gcGFyYW1zO1xuICBjb25zdCBub3RlRnVsbFBhdGggPSB0b1Bvc2l4UGF0aChnZXREYXRhQWRhcHRlckV4KGFwcCkuZ2V0RnVsbFJlYWxQYXRoKG5vdGVQYXRoKSk7XG4gIGNvbnN0IG5vdGVVcmwgPSBgJHtQbGF0Zm9ybS5yZXNvdXJjZVBhdGhQcmVmaXh9JHtub3RlRnVsbFBhdGh9YDtcbiAgY29uc3QgcmVsYXRpdmVVcmwgPSBuZXcgVVJMKHJlbGF0aXZlUGF0aCwgbm90ZVVybCk7XG4gIHJldHVybiByZWxhdGl2ZVVybC5ocmVmO1xufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQVFBLFNBQVMsbUJBQW1CO0FBQzVCLFNBQVMsd0JBQXdCO0FBQ2pDLFNBQVMsZ0JBQWdCO0FBNEJsQixTQUFTLDBCQUEwQixRQUFpRDtBQUN6RixRQUFNO0FBQUEsSUFDSjtBQUFBLElBQ0E7QUFBQSxJQUNBO0FBQUEsRUFDRixJQUFJO0FBQ0osUUFBTSxlQUFlLFlBQVksaUJBQWlCLEdBQUcsRUFBRSxnQkFBZ0IsUUFBUSxDQUFDO0FBQ2hGLFFBQU0sVUFBVSxHQUFHLFNBQVMsa0JBQWtCLEdBQUcsWUFBWTtBQUM3RCxRQUFNLGNBQWMsSUFBSSxJQUFJLGNBQWMsT0FBTztBQUNqRCxTQUFPLFlBQVk7QUFDckI7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/ribbon-icon-registrar.d.mts

@@ -0,0 +1,60 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * Ribbon icon registrars.
+ */
+import type { IconName } from 'obsidian';
+import { Plugin } from 'obsidian';
+/**
+ * Ribbon icon registrar.
+ */
+export interface RibbonIconRegistrar {
+    /**
+     * Registers a ribbon icon.
+     *
+     * @param params - The parameters for the ribbon icon registration.
+     * @returns The HTML element representing the registered ribbon icon.
+     */
+    addRibbonIcon: (params: RibbonIconRegistrarAddRibbonIconParams) => HTMLElement;
+}
+/**
+ * Parameters for registering a ribbon icon.
+ */
+export interface RibbonIconRegistrarAddRibbonIconParams {
+    /**
+     * Callback function for the ribbon icon to register.
+     *
+     * @param $event - The mouse event that triggered the callback.
+     */
+    readonly callback: ($event: MouseEvent) => void;
+    /**
+     * The icon name for the ribbon icon to register.
+     */
+    readonly icon: IconName;
+    /**
+     * The title for the ribbon icon to register.
+     */
+    readonly title: string;
+}
+type PluginRibbonIconRegistrarAddRibbonIconParams = RibbonIconRegistrarAddRibbonIconParams;
+/**
+ * Ribbon icon registrar in an Obsidian plugin.
+ */
+export declare class PluginRibbonIconRegistrar implements RibbonIconRegistrar {
+    protected readonly plugin: Plugin;
+    /**
+     * Creates a new instance of the {@link PluginRibbonIconRegistrar} class.
+     *
+     * @param plugin - The Obsidian plugin instance.
+     */
+    constructor(plugin: Plugin);
+    /**
+     * Registers a ribbon icon.
+     *
+     * @param params - The parameters for the ribbon icon registration.
+     * @returns The HTML element representing the registered ribbon icon.
+     */
+    addRibbonIcon(params: PluginRibbonIconRegistrarAddRibbonIconParams): HTMLElement;
+}
+export {};

package/dist/lib/esm/ribbon-icon-registrar.mjs

@@ -0,0 +1,74 @@
+/*
+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 initEsm() {
+  ensureDisposeSymbols();
+  ensureBrowserProcess();
+})();
+})();
+
+import { Plugin } from "obsidian";
+class PluginRibbonIconRegistrar {
+  /**
+   * Creates a new instance of the {@link PluginRibbonIconRegistrar} class.
+   *
+   * @param plugin - The Obsidian plugin instance.
+   */
+  constructor(plugin) {
+    this.plugin = plugin;
+  }
+  plugin;
+  /**
+   * Registers a ribbon icon.
+   *
+   * @param params - The parameters for the ribbon icon registration.
+   * @returns The HTML element representing the registered ribbon icon.
+   */
+  addRibbonIcon(params) {
+    return this.plugin.addRibbonIcon(params.icon, params.title, params.callback);
+  }
+}
+export {
+  PluginRibbonIconRegistrar
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL3JpYmJvbi1pY29uLXJlZ2lzdHJhci50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIFJpYmJvbiBpY29uIHJlZ2lzdHJhcnMuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBJY29uTmFtZSB9IGZyb20gJ29ic2lkaWFuJztcblxuaW1wb3J0IHsgUGx1Z2luIH0gZnJvbSAnb2JzaWRpYW4nO1xuXG4vKipcbiAqIFJpYmJvbiBpY29uIHJlZ2lzdHJhci5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBSaWJib25JY29uUmVnaXN0cmFyIHtcbiAgLyoqXG4gICAqIFJlZ2lzdGVycyBhIHJpYmJvbiBpY29uLlxuICAgKlxuICAgKiBAcGFyYW0gcGFyYW1zIC0gVGhlIHBhcmFtZXRlcnMgZm9yIHRoZSByaWJib24gaWNvbiByZWdpc3RyYXRpb24uXG4gICAqIEByZXR1cm5zIFRoZSBIVE1MIGVsZW1lbnQgcmVwcmVzZW50aW5nIHRoZSByZWdpc3RlcmVkIHJpYmJvbiBpY29uLlxuICAgKi9cbiAgYWRkUmliYm9uSWNvbjogKHBhcmFtczogUmliYm9uSWNvblJlZ2lzdHJhckFkZFJpYmJvbkljb25QYXJhbXMpID0+IEhUTUxFbGVtZW50O1xufVxuXG4vKipcbiAqIFBhcmFtZXRlcnMgZm9yIHJlZ2lzdGVyaW5nIGEgcmliYm9uIGljb24uXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUmliYm9uSWNvblJlZ2lzdHJhckFkZFJpYmJvbkljb25QYXJhbXMge1xuICAvKipcbiAgICogQ2FsbGJhY2sgZnVuY3Rpb24gZm9yIHRoZSByaWJib24gaWNvbiB0byByZWdpc3Rlci5cbiAgICpcbiAgICogQHBhcmFtICRldmVudCAtIFRoZSBtb3VzZSBldmVudCB0aGF0IHRyaWdnZXJlZCB0aGUgY2FsbGJhY2suXG4gICAqL1xuICByZWFkb25seSBjYWxsYmFjazogKCRldmVudDogTW91c2VFdmVudCkgPT4gdm9pZDtcblxuICAvKipcbiAgICogVGhlIGljb24gbmFtZSBmb3IgdGhlIHJpYmJvbiBpY29uIHRvIHJlZ2lzdGVyLlxuICAgKi9cbiAgcmVhZG9ubHkgaWNvbjogSWNvbk5hbWU7XG5cbiAgLyoqXG4gICAqIFRoZSB0aXRsZSBmb3IgdGhlIHJpYmJvbiBpY29uIHRvIHJlZ2lzdGVyLlxuICAgKi9cbiAgcmVhZG9ubHkgdGl0bGU6IHN0cmluZztcbn1cblxudHlwZSBQbHVnaW5SaWJib25JY29uUmVnaXN0cmFyQWRkUmliYm9uSWNvblBhcmFtcyA9IFJpYmJvbkljb25SZWdpc3RyYXJBZGRSaWJib25JY29uUGFyYW1zO1xuXG4vKipcbiAqIFJpYmJvbiBpY29uIHJlZ2lzdHJhciBpbiBhbiBPYnNpZGlhbiBwbHVnaW4uXG4gKi9cbmV4cG9ydCBjbGFzcyBQbHVnaW5SaWJib25JY29uUmVnaXN0cmFyIGltcGxlbWVudHMgUmliYm9uSWNvblJlZ2lzdHJhciB7XG4gIC8qKlxuICAgKiBDcmVhdGVzIGEgbmV3IGluc3RhbmNlIG9mIHRoZSB7QGxpbmsgUGx1Z2luUmliYm9uSWNvblJlZ2lzdHJhcn0gY2xhc3MuXG4gICAqXG4gICAqIEBwYXJhbSBwbHVnaW4gLSBUaGUgT2JzaWRpYW4gcGx1Z2luIGluc3RhbmNlLlxuICAgKi9cbiAgcHVibGljIGNvbnN0cnVjdG9yKHByb3RlY3RlZCByZWFkb25seSBwbHVnaW46IFBsdWdpbikge31cblxuICAvKipcbiAgICogUmVnaXN0ZXJzIGEgcmliYm9uIGljb24uXG4gICAqXG4gICAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgcGFyYW1ldGVycyBmb3IgdGhlIHJpYmJvbiBpY29uIHJlZ2lzdHJhdGlvbi5cbiAgICogQHJldHVybnMgVGhlIEhUTUwgZWxlbWVudCByZXByZXNlbnRpbmcgdGhlIHJlZ2lzdGVyZWQgcmliYm9uIGljb24uXG4gICAqL1xuICBwdWJsaWMgYWRkUmliYm9uSWNvbihwYXJhbXM6IFBsdWdpblJpYmJvbkljb25SZWdpc3RyYXJBZGRSaWJib25JY29uUGFyYW1zKTogSFRNTEVsZW1lbnQge1xuICAgIHJldHVybiB0aGlzLnBsdWdpbi5hZGRSaWJib25JY29uKHBhcmFtcy5pY29uLCBwYXJhbXMudGl0bGUsIHBhcmFtcy5jYWxsYmFjayk7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFRQSxTQUFTLGNBQWM7QUEwQ2hCLE1BQU0sMEJBQXlEO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBTTdELFlBQStCLFFBQWdCO0FBQWhCO0FBQUEsRUFBaUI7QUFBQSxFQUFqQjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUS9CLGNBQWMsUUFBbUU7QUFDdEYsV0FBTyxLQUFLLE9BQU8sY0FBYyxPQUFPLE1BQU0sT0FBTyxPQUFPLE9BQU8sUUFBUTtBQUFBLEVBQzdFO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/setting-components/checkbox-component.d.mts

@@ -0,0 +1,69 @@
+/// <reference path="../library.d.mts" />
+/**
+ * @file
+ *
+ * Checkbox component.
+ */
+import type { ValidatorElement } from '@mnaoumov/typescript-lib/html-element';
+import { ValueComponent } from 'obsidian';
+import type { ValidatorComponent } from './validator-component.mjs';
+import type { ValueComponentWithChangeTracking } from './value-component-with-change-tracking.mjs';
+/**
+ * A component that displays a checkbox.
+ *
+ * You can add this component using {@link SettingEx.addCheckbox}.
+ *
+ * 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 CheckboxComponent extends ValueComponent<boolean> implements ValidatorComponent, ValueComponentWithChangeTracking<boolean> {
+    /**
+     * 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 checkbox component.
+     *
+     * @param containerEl - The container element.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Gets the value of the checkbox.
+     *
+     * @returns The value of the checkbox.
+     */
+    getValue(): boolean;
+    /**
+     * 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: (isChecked: boolean) => 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 isChecked - The value to set the checkbox to.
+     * @returns The component.
+     */
+    setValue(isChecked: boolean): this;
+}

package/dist/lib/esm/setting-components/checkbox-component.mjs

@@ -0,0 +1,127 @@
+/*
+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 initEsm() {
+  ensureDisposeSymbols();
+  ensureBrowserProcess();
+})();
+})();
+
+import { ValueComponent } from "obsidian";
+import { CssClass } from "../css-class.mjs";
+import { addPluginCssClasses } from "../plugin/plugin-context.mjs";
+class CheckboxComponent extends 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 checkbox component.
+   *
+   * @param containerEl - The container element.
+   */
+  constructor(containerEl) {
+    super();
+    addPluginCssClasses(containerEl, [CssClass.CheckboxComponent]);
+    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.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 isChecked - The value to set the checkbox to.
+   * @returns The component.
+   */
+  setValue(isChecked) {
+    this.inputEl.checked = isChecked;
+    return this;
+  }
+}
+export {
+  CheckboxComponent
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL3NldHRpbmctY29tcG9uZW50cy9jaGVja2JveC1jb21wb25lbnQudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBDaGVja2JveCBjb21wb25lbnQuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBWYWxpZGF0b3JFbGVtZW50IH0gZnJvbSAnQG1uYW91bW92L3R5cGVzY3JpcHQtbGliL2h0bWwtZWxlbWVudCc7XG5cbmltcG9ydCB7IFZhbHVlQ29tcG9uZW50IH0gZnJvbSAnb2JzaWRpYW4nO1xuXG4vLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzIC0tIFdlIG5lZWQgdG8gaW1wb3J0IGBpbml0UGx1Z2luQ29udGV4dGAgdG8gdXNlIGl0IGluIHRoZSB0c2RvY3MuXG5pbXBvcnQgdHlwZSB7IGluaXRQbHVnaW5Db250ZXh0IH0gZnJvbSAnLi4vcGx1Z2luL3BsdWdpbi1jb250ZXh0LnRzJztcbi8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdW51c2VkLXZhcnMgLS0gV2UgbmVlZCB0byBpbXBvcnQgYFNldHRpbmdFeGAgdG8gdXNlIGl0IGluIHRoZSB0c2RvY3MuXG5pbXBvcnQgdHlwZSB7IFNldHRpbmdFeCB9IGZyb20gJy4uL3NldHRpbmctZXgudHMnO1xuaW1wb3J0IHR5cGUgeyBWYWxpZGF0b3JDb21wb25lbnQgfSBmcm9tICcuL3ZhbGlkYXRvci1jb21wb25lbnQudHMnO1xuaW1wb3J0IHR5cGUgeyBWYWx1ZUNvbXBvbmVudFdpdGhDaGFuZ2VUcmFja2luZyB9IGZyb20gJy4vdmFsdWUtY29tcG9uZW50LXdpdGgtY2hhbmdlLXRyYWNraW5nLnRzJztcblxuaW1wb3J0IHsgQ3NzQ2xhc3MgfSBmcm9tICcuLi9jc3MtY2xhc3MudHMnO1xuaW1wb3J0IHsgYWRkUGx1Z2luQ3NzQ2xhc3NlcyB9IGZyb20gJy4uL3BsdWdpbi9wbHVnaW4tY29udGV4dC50cyc7XG5cbi8qKlxuICogQSBjb21wb25lbnQgdGhhdCBkaXNwbGF5cyBhIGNoZWNrYm94LlxuICpcbiAqIFlvdSBjYW4gYWRkIHRoaXMgY29tcG9uZW50IHVzaW5nIHtAbGluayBTZXR0aW5nRXguYWRkQ2hlY2tib3h9LlxuICpcbiAqIEluIG9yZGVyIHRvIGFkZCB0aGUgc3R5bGVzIGZvciB0aGUgY29tcG9uZW50LCB1c2Uge0BsaW5rIGluaXRQbHVnaW5Db250ZXh0fSBpbiB5b3VyIHBsdWdpbidzIGBvbmxvYWQoKWAgZnVuY3Rpb24uXG4gKlxuICogQWx0ZXJuYXRpdmVseSwgeW91IGNhbiBjb3B5IHN0eWxlcyBmcm9tIHtAbGluayBodHRwczovL2dpdGh1Yi5jb20vbW5hb3Vtb3Yvb2JzaWRpYW4tZGV2LXV0aWxzL3JlbGVhc2VzL2xhdGVzdC9kb3dubG9hZC9zdHlsZXMuY3NzfS5cbiAqL1xuZXhwb3J0IGNsYXNzIENoZWNrYm94Q29tcG9uZW50IGV4dGVuZHMgVmFsdWVDb21wb25lbnQ8Ym9vbGVhbj4gaW1wbGVtZW50cyBWYWxpZGF0b3JDb21wb25lbnQsIFZhbHVlQ29tcG9uZW50V2l0aENoYW5nZVRyYWNraW5nPGJvb2xlYW4+IHtcbiAgLyoqXG4gICAqIEFuIGlucHV0IGVsZW1lbnQgb2YgdGhlIGNoZWNrYm94LlxuICAgKi9cbiAgcHVibGljIHJlYWRvbmx5IGlucHV0RWw6IEhUTUxJbnB1dEVsZW1lbnQ7XG5cbiAgLyoqXG4gICAqIEEgdmFsaWRhdG9yIGVsZW1lbnQgb2YgdGhlIGNoZWNrYm94LlxuICAgKlxuICAgKiBAcmV0dXJucyBUaGUgdmFsaWRhdG9yIGVsZW1lbnQuXG4gICAqL1xuICBwdWJsaWMgZ2V0IHZhbGlkYXRvckVsKCk6IFZhbGlkYXRvckVsZW1lbnQge1xuICAgIHJldHVybiB0aGlzLmlucHV0RWw7XG4gIH1cblxuICBwcml2YXRlIGNoYW5nZUNhbGxiYWNrPzogKGlzQ2hlY2tlZDogYm9vbGVhbikgPT4gdm9pZDtcblxuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyBjaGVja2JveCBjb21wb25lbnQuXG4gICAqXG4gICAqIEBwYXJhbSBjb250YWluZXJFbCAtIFRoZSBjb250YWluZXIgZWxlbWVudC5cbiAgICovXG4gIHB1YmxpYyBjb25zdHJ1Y3Rvcihjb250YWluZXJFbDogSFRNTEVsZW1lbnQpIHtcbiAgICBzdXBlcigpO1xuICAgIGFkZFBsdWdpbkNzc0NsYXNzZXMoY29udGFpbmVyRWwsIFtDc3NDbGFzcy5DaGVja2JveENvbXBvbmVudF0pO1xuICAgIHRoaXMuaW5wdXRFbCA9IGNvbnRhaW5lckVsLmNyZWF0ZUVsKCdpbnB1dCcsIHsgdHlwZTogJ2NoZWNrYm94JyB9KTtcbiAgICB0aGlzLmlucHV0RWwuYWRkRXZlbnRMaXN0ZW5lcignY2hhbmdlJywgdGhpcy5vbkNoYW5nZWQuYmluZCh0aGlzKSk7XG4gIH1cblxuICAvKipcbiAgICogR2V0cyB0aGUgdmFsdWUgb2YgdGhlIGNoZWNrYm94LlxuICAgKlxuICAgKiBAcmV0dXJucyBUaGUgdmFsdWUgb2YgdGhlIGNoZWNrYm94LlxuICAgKi9cbiAgcHVibGljIG92ZXJyaWRlIGdldFZhbHVlKCk6IGJvb2xlYW4ge1xuICAgIHJldHVybiB0aGlzLmlucHV0RWwuY2hlY2tlZDtcbiAgfVxuXG4gIC8qKlxuICAgKiBTZXRzIHRoZSBjYWxsYmFjayB0byBiZSBjYWxsZWQgd2hlbiB0aGUgY2hlY2tib3ggaXMgY2hhbmdlZC5cbiAgICpcbiAgICogQHBhcmFtIGNhbGxiYWNrIC0gVGhlIGNhbGxiYWNrIHRvIGJlIGNhbGxlZCB3aGVuIHRoZSBjaGVja2JveCBpcyBjaGFuZ2VkLlxuICAgKiBAcmV0dXJucyBUaGUgY29tcG9uZW50LlxuICAgKi9cbiAgcHVibGljIG9uQ2hhbmdlKGNhbGxiYWNrOiAoaXNDaGVja2VkOiBib29sZWFuKSA9PiB2b2lkKTogdGhpcyB7XG4gICAgdGhpcy5jaGFuZ2VDYWxsYmFjayA9IGNhbGxiYWNrO1xuICAgIHJldHVybiB0aGlzO1xuICB9XG5cbiAgLyoqXG4gICAqIENhbGxlZCB3aGVuIHRoZSBjaGVja2JveCBpcyBjaGFuZ2VkLlxuICAgKi9cbiAgcHVibGljIG9uQ2hhbmdlZCgpOiB2b2lkIHtcbiAgICB0aGlzLmNoYW5nZUNhbGxiYWNrPy4odGhpcy5nZXRWYWx1ZSgpKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBTZXRzIHRoZSBkaXNhYmxlZCBzdGF0ZSBvZiB0aGUgY2hlY2tib3guXG4gICAqXG4gICAqIEBwYXJhbSBpc0Rpc2FibGVkIC0gVGhlIGRpc2FibGVkIHN0YXRlIG9mIHRoZSBjaGVja2JveC5cbiAgICogQHJldHVybnMgVGhlIGNvbXBvbmVudC5cbiAgICovXG4gIHB1YmxpYyBvdmVycmlkZSBzZXREaXNhYmxlZChpc0Rpc2FibGVkOiBib29sZWFuKTogdGhpcyB7XG4gICAgc3VwZXIuc2V0RGlzYWJsZWQoaXNEaXNhYmxlZCk7XG4gICAgdGhpcy5pbnB1dEVsLmRpc2FibGVkID0gaXNEaXNhYmxlZDtcbiAgICByZXR1cm4gdGhpcztcbiAgfVxuXG4gIC8qKlxuICAgKiBTZXRzIHRoZSB2YWx1ZSBvZiB0aGUgY2hlY2tib3guXG4gICAqXG4gICAqIEBwYXJhbSBpc0NoZWNrZWQgLSBUaGUgdmFsdWUgdG8gc2V0IHRoZSBjaGVja2JveCB0by5cbiAgICogQHJldHVybnMgVGhlIGNvbXBvbmVudC5cbiAgICovXG4gIHB1YmxpYyBvdmVycmlkZSBzZXRWYWx1ZShpc0NoZWNrZWQ6IGJvb2xlYW4pOiB0aGlzIHtcbiAgICB0aGlzLmlucHV0RWwuY2hlY2tlZCA9IGlzQ2hlY2tlZDtcbiAgICByZXR1cm4gdGhpcztcbiAgfVxufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQVFBLFNBQVMsc0JBQXNCO0FBUy9CLFNBQVMsZ0JBQWdCO0FBQ3pCLFNBQVMsMkJBQTJCO0FBVzdCLE1BQU0sMEJBQTBCLGVBQWlHO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFJdEg7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPaEIsSUFBVyxjQUFnQztBQUN6QyxXQUFPLEtBQUs7QUFBQSxFQUNkO0FBQUEsRUFFUTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9ELFlBQVksYUFBMEI7QUFDM0MsVUFBTTtBQUNOLHdCQUFvQixhQUFhLENBQUMsU0FBUyxpQkFBaUIsQ0FBQztBQUM3RCxTQUFLLFVBQVUsWUFBWSxTQUFTLFNBQVMsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUNqRSxTQUFLLFFBQVEsaUJBQWlCLFVBQVUsS0FBSyxVQUFVLEtBQUssSUFBSSxDQUFDO0FBQUEsRUFDbkU7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPZ0IsV0FBb0I7QUFDbEMsV0FBTyxLQUFLLFFBQVE7QUFBQSxFQUN0QjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUU8sU0FBUyxVQUE4QztBQUM1RCxTQUFLLGlCQUFpQjtBQUN0QixXQUFPO0FBQUEsRUFDVDtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBS08sWUFBa0I7QUFDdkIsU0FBSyxpQkFBaUIsS0FBSyxTQUFTLENBQUM7QUFBQSxFQUN2QztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUWdCLFlBQVksWUFBMkI7QUFDckQsVUFBTSxZQUFZLFVBQVU7QUFDNUIsU0FBSyxRQUFRLFdBQVc7QUFDeEIsV0FBTztBQUFBLEVBQ1Q7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVFnQixTQUFTLFdBQTBCO0FBQ2pELFNBQUssUUFBUSxVQUFVO0FBQ3ZCLFdBQU87QUFBQSxFQUNUO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/setting-components/code-highlighter-component.d.mts

@@ -0,0 +1,132 @@
+/// <reference path="../library.d.mts" />
+/**
+ * @file
+ *
+ * Contains a component that displays and edits multiple text values.
+ */
+import type { ValidatorElement } from '@mnaoumov/typescript-lib/html-element';
+import { TextAreaComponent, ValueComponent } from 'obsidian';
+import type { TextBasedComponent } from './text-based-component.mjs';
+import type { ValidatorComponent } from './validator-component.mjs';
+import type { ValueComponentWithChangeTracking } from './value-component-with-change-tracking.mjs';
+/**
+ * A component that displays and edits code.
+ *
+ * You can add this component using {@link SettingEx.addCodeHighlighter}.
+ *
+ * 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 CodeHighlighterComponent extends ValueComponent<string> implements TextBasedComponent<string>, ValidatorComponent, ValueComponentWithChangeTracking<string> {
+    /**
+     * An input element of the component.
+     *
+     * @returns The input element of the component.
+     */
+    get inputEl(): HTMLTextAreaElement;
+    /**
+     * Gets the validator element of the component.
+     *
+     * @returns The validator element of the component.
+     */
+    get validatorEl(): ValidatorElement;
+    /**
+     * The `<code>` element that renders the syntax-highlighted overlay. Subclasses customizing the highlighting can target it.
+     */
+    protected readonly codeEl: HTMLElement;
+    /**
+     * The `<pre>` element that wraps the highlighted code overlay. Subclasses customizing the highlighting can target it.
+     */
+    protected readonly preEl: HTMLElement;
+    /**
+     * The inner text area component.
+     */
+    protected readonly textAreaComponent: TextAreaComponent;
+    private placeholder;
+    private simulateChangeCallback?;
+    private tabSize;
+    /**
+     * Creates a new multiple text component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Empties the component.
+     */
+    empty(): void;
+    /**
+     * Gets the value of the component.
+     *
+     * @returns The value of the component.
+     */
+    getValue(): string;
+    /**
+     * Checks if the component is empty.
+     *
+     * @returns `true` if the component is empty, `false` otherwise.
+     */
+    isEmpty(): boolean;
+    /**
+     * Adds a change listener to the component.
+     *
+     * @param callback - The callback to call when the value changes.
+     * @returns The component.
+     */
+    onChange(callback: (newValue: string) => void): this;
+    /**
+     * Sets the disabled state of the component.
+     *
+     * @param isDisabled - The disabled state to set.
+     * @returns The component.
+     */
+    setDisabled(isDisabled: boolean): this;
+    /**
+     * Sets the language for code highlighting.
+     *
+     * @param language - The language to set.
+     * @returns The component.
+     */
+    setLanguage(language: string): this;
+    /**
+     * Sets the placeholder of the component.
+     *
+     * @param placeholder - The placeholder to set.
+     * @returns The component.
+     */
+    setPlaceholder(placeholder: string): this;
+    /**
+     * Sets the placeholder value of the component.
+     *
+     * @param placeholderValue - The placeholder value to set.
+     * @returns The component.
+     */
+    setPlaceholderValue(placeholderValue: string): this;
+    /**
+     * Sets the tab size of the component.
+     *
+     * @param tabSize - The tab size to set.
+     * @returns The component.
+     */
+    setTabSize(tabSize: number): this;
+    /**
+     * Sets the value of the component.
+     *
+     * @param value - The value to set.
+     * @returns The component.
+     */
+    setValue(value: string): this;
+    /**
+     * Simulate a change event.
+     *
+     * @deprecated Use only from tests to simulate a change event.
+     */
+    simulateChange__(): void;
+    /**
+     * Re-renders the highlighted code overlay from the current text area value. Subclasses can override to customize the render.
+     */
+    protected updateHighlightedCode(): Promise<void>;
+    private handleKeyDown;
+    private handleScroll;
+}