obsidian-dev-utils 19.1.2-beta.2 → 19.1.2-beta.4

package/dist/lib/esm/obsidian/Components/DateComponent.d.mts

@@ -1 +1,36 @@
-export * from '../../../cjs/obsidian/Components/DateComponent.cjs';
+/**
+ * @packageDocumentation DateComponent
+ * Contains a component that displays and edits a date.
+ */
+import type { TypedRangeTextComponent } from './TypedRangeTextComponent.d.mts';
+/**
+ * A component that displays and edits a date.
+ *
+ * You can add this component using {@link SettingEx.addDate}.
+ *
+ * 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 DateComponent extends TypedRangeTextComponent<Date> {
+    /**
+     * Creates a new date component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to a date.
+     *
+     * @param str - The string to convert.
+     * @returns The date.
+     */
+    valueFromString(str: string): Date;
+    /**
+     * Converts a date to a string.
+     *
+     * @param value - The date to convert.
+     * @returns The string.
+     */
+    valueToString(value: Date): string;
+}

package/dist/lib/esm/obsidian/Components/DateTimeComponent.d.mts

@@ -1 +1,36 @@
-export * from '../../../cjs/obsidian/Components/DateTimeComponent.cjs';
+/**
+ * @packageDocumentation DateTimeComponent
+ * Contains a component that displays and edits a date and time.
+ */
+import type { TypedRangeTextComponent } from './TypedRangeTextComponent.d.mts';
+/**
+ * A component that displays and edits a date and time.
+ *
+ * You can add this component using {@link SettingEx.addDateTime}.
+ *
+ * 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 DateTimeComponent extends TypedRangeTextComponent<Date> {
+    /**
+     * Creates a new date and time component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to a date.
+     *
+     * @param str - The string to convert.
+     * @returns The date.
+     */
+    valueFromString(str: string): Date;
+    /**
+     * Converts a date to a string.
+     *
+     * @param value - The date to convert.
+     * @returns The string.
+     */
+    valueToString(value: Date): string;
+}

package/dist/lib/esm/obsidian/Components/EmailComponent.d.mts

@@ -1 +1,29 @@
-export * from '../../../cjs/obsidian/Components/EmailComponent.cjs';
+/**
+ * @packageDocumentation EmailComponent
+ * Contains a component that displays and edits an email address.
+ */
+import type { TypedTextComponent } from './TypedTextComponent.d.mts';
+/**
+ * A component that displays and edits an email address.
+ *
+ * You can add this component using {@link SettingEx.addEmail}.
+ *
+ * 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 EmailComponent extends TypedTextComponent<string> {
+    /**
+     * Creates a new email component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to an email address.
+     *
+     * @param str - The string to convert.
+     * @returns The email address.
+     */
+    valueFromString(str: string): string;
+}

package/dist/lib/esm/obsidian/Components/FileComponent.d.mts

@@ -1 +1,41 @@
-export * from '../../../cjs/obsidian/Components/FileComponent.cjs';
+/**
+ * @packageDocumentation FileComponent
+ * Contains a component that displays and edits a file.
+ */
+import type { TypedTextComponent } from './TypedTextComponent.d.mts';
+/**
+ * A component that displays and edits a file.
+ *
+ * You can add this component using {@link SettingEx.addFile}.
+ *
+ * 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 FileComponent extends TypedTextComponent<File | null> {
+    /**
+     * Creates a new file component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Gets the value of the component.
+     *
+     * @returns The value of the component.
+     */
+    getValue(): File | null;
+    /**
+     * Converts a string to a file.
+     *
+     * @returns The file.
+     */
+    valueFromString(): File | null;
+    /**
+     * Converts a file to a string.
+     *
+     * @param value - The file to convert.
+     * @returns The string.
+     */
+    valueToString(value: File | null): string;
+}

package/dist/lib/esm/obsidian/Components/MonthComponent.d.mts

@@ -1 +1,49 @@
-export * from '../../../cjs/obsidian/Components/MonthComponent.cjs';
+/**
+ * @packageDocumentation MonthComponent
+ * Contains a component that displays and edits a month.
+ */
+import type { TypedRangeTextComponent } from './TypedRangeTextComponent.d.mts';
+/**
+ * An ISO 8601 month.
+ */
+export interface IsoMonth {
+    /**
+     * The month (1-12).
+     */
+    month: number;
+    /**
+     * The year (1-9999).
+     */
+    year: number;
+}
+/**
+ * A component that displays and edits a month.
+ *
+ * You can add this component using {@link SettingEx.addMonth}.
+ *
+ * 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 MonthComponent extends TypedRangeTextComponent<IsoMonth> {
+    /**
+     * Creates a new month component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to a month.
+     *
+     * @param str - The string to convert.
+     * @returns The month.
+     */
+    valueFromString(str: string): IsoMonth;
+    /**
+     * Converts a month to a string.
+     *
+     * @param value - The month to convert.
+     * @returns The string.
+     */
+    valueToString(value: IsoMonth): string;
+}

package/dist/lib/esm/obsidian/Components/MultipleDropdownComponent.d.mts

@@ -1 +1,73 @@
-export * from '../../../cjs/obsidian/Components/MultipleDropdownComponent.cjs';
+/**
+ * @packageDocumentation MultipleDropdownComponent
+ * Contains a component that displays and edits a multi-select dropdown.
+ */
+import type { ValueComponent } from 'obsidian';
+import type { MaybePromise } from '../../Async.d.mts';
+import type { ValidatorElement } from '../../HTMLElement.d.mts';
+import type { ValidatorComponent } from './ValidatorComponent.d.mts';
+import type { ValueComponentWithChangeTracking } from './ValueComponentWithChangeTracking.d.mts';
+/**
+ * A multi-select dropdown component.
+ *
+ * You can add this component using {@link SettingEx.addMultipleDropdown}.
+ *
+ * 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 MultipleDropdownComponent extends ValueComponent<string[]> implements ValidatorComponent, ValueComponentWithChangeTracking<string[]> {
+    /**
+     * The validator element of the component.
+     */
+    get validatorEl(): ValidatorElement;
+    private readonly dropdownComponent;
+    /**
+     * Creates a new multiple dropdown component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Adds an option to the dropdown.
+     *
+     * @param value - The value of the option.
+     * @param display - The display text of the option.
+     * @returns The component.
+     */
+    addOption(value: string, display: string): this;
+    /**
+     * Adds multiple options to the dropdown.
+     *
+     * @param options - The options to add.
+     * @returns The component.
+     */
+    addOptions(options: Record<string, string>): this;
+    /**
+     * Gets the value of the component.
+     *
+     * @returns The value of the component.
+     */
+    getValue(): string[];
+    /**
+     * Sets the callback function to be called when the component is changed.
+     *
+     * @param callback - The callback function to be called when the component is changed.
+     * @returns The component.
+     */
+    onChange(callback: (value: string[]) => MaybePromise<void>): this;
+    /**
+     * Sets the disabled state of the component.
+     *
+     * @param disabled - The disabled state to set.
+     * @returns The component.
+     */
+    setDisabled(disabled: boolean): this;
+    /**
+     * Sets the value of the component.
+     *
+     * @param value - The value to set.
+     * @returns The component.
+     */
+    setValue(value: string[]): this;
+}

package/dist/lib/esm/obsidian/Components/MultipleEmailComponent.d.mts

@@ -1 +1,36 @@
-export * from '../../../cjs/obsidian/Components/MultipleEmailComponent.cjs';
+/**
+ * @packageDocumentation MultipleEmailComponent
+ * Contains a component that displays and edits multiple email addresses.
+ */
+import type { TypedTextComponent } from './TypedTextComponent.d.mts';
+/**
+ * A component that displays and edits multiple email addresses.
+ *
+ * You can add this component using {@link SettingEx.addMultipleEmail}.
+ *
+ * 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 MultipleEmailComponent extends TypedTextComponent<string[]> {
+    /**
+     * Creates a new multiple emails component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to an email address.
+     *
+     * @param str - The string to convert.
+     * @returns The email address.
+     */
+    valueFromString(str: string): string[];
+    /**
+     * Converts an email address to a string.
+     *
+     * @param value - The email address to convert.
+     * @returns The string.
+     */
+    valueToString(value: string[]): string;
+}

package/dist/lib/esm/obsidian/Components/MultipleFileComponent.d.mts

@@ -1 +1,41 @@
-export * from '../../../cjs/obsidian/Components/MultipleFileComponent.cjs';
+/**
+ * @packageDocumentation MultipleFileComponent
+ * Contains a component that displays and edits multiple files.
+ */
+import type { TypedTextComponent } from './TypedTextComponent.d.mts';
+/**
+ * A component that displays and edits multiple files.
+ *
+ * You can add this component using {@link SettingEx.addMultipleFile}.
+ *
+ * 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 MultipleFileComponent extends TypedTextComponent<File[]> {
+    /**
+     * Creates a new multiple file component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Gets the value of the component.
+     *
+     * @returns The value of the component.
+     */
+    getValue(): File[];
+    /**
+     * Converts a string to a file.
+     *
+     * @returns The file.
+     */
+    valueFromString(): File[];
+    /**
+     * Converts a file to a string.
+     *
+     * @param value - The file to convert.
+     * @returns The string.
+     */
+    valueToString(value: File[]): string;
+}

package/dist/lib/esm/obsidian/Components/MultipleTextComponent.d.mts

@@ -1 +1,67 @@
-export * from '../../../cjs/obsidian/Components/MultipleTextComponent.cjs';
+/**
+ * @packageDocumentation MultipleTextComponent
+ * Contains a component that displays and edits multiple text values.
+ */
+import type { ValueComponent } from 'obsidian';
+import type { MaybePromise } from '../../Async.d.mts';
+import type { ValidatorElement } from '../../HTMLElement.d.mts';
+import type { ValidatorComponent } from './ValidatorComponent.d.mts';
+import type { ValueComponentWithChangeTracking } from './ValueComponentWithChangeTracking.d.mts';
+/**
+ * A component that displays and edits multiple text values.
+ *
+ * You can add this component using {@link SettingEx.addMultipleText}.
+ *
+ * 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 MultipleTextComponent extends ValueComponent<string[]> implements ValidatorComponent, ValueComponentWithChangeTracking<string[]> {
+    /**
+     * Gets the validator element of the component.
+     *
+     * @returns The validator element of the component.
+     */
+    get validatorEl(): ValidatorElement;
+    private readonly textAreaComponent;
+    /**
+     * Creates a new multiple text component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Gets the value of the component.
+     *
+     * @returns The value of the component.
+     */
+    getValue(): string[];
+    /**
+     * Adds a change listener to the component.
+     *
+     * @param callback - The callback to call when the value changes.
+     * @returns The component.
+     */
+    onChange(callback: (newValue: string[]) => MaybePromise<void>): this;
+    /**
+     * Sets the disabled state of the component.
+     *
+     * @param disabled - The disabled state to set.
+     * @returns The component.
+     */
+    setDisabled(disabled: boolean): this;
+    /**
+     * Sets the placeholder of the component.
+     *
+     * @param placeholder - The placeholder to set.
+     * @returns The component.
+     */
+    setPlaceholder(placeholder: string): this;
+    /**
+     * Sets the value of the component.
+     *
+     * @param value - The value to set.
+     * @returns The component.
+     */
+    setValue(value: string[]): this;
+}

package/dist/lib/esm/obsidian/Components/NumberComponent.d.mts

@@ -1 +1,29 @@
-export * from '../../../cjs/obsidian/Components/NumberComponent.cjs';
+/**
+ * @packageDocumentation NumberComponent
+ * Contains a component that displays and edits a number.
+ */
+import type { TypedRangeTextComponent } from './TypedRangeTextComponent.d.mts';
+/**
+ * A component that displays and edits a number.
+ *
+ * You can add this component using {@link SettingEx.addNumber}.
+ *
+ * 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 NumberComponent extends TypedRangeTextComponent<number> {
+    /**
+     * Creates a new number component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to a number.
+     *
+     * @param str - The string to convert.
+     * @returns The number.
+     */
+    valueFromString(str: string): number;
+}

package/dist/lib/esm/obsidian/Components/TimeComponent.d.mts

@@ -1 +1,37 @@
-export * from '../../../cjs/obsidian/Components/TimeComponent.cjs';
+/**
+ * @packageDocumentation TimeComponent
+ * Contains a component that displays and edits a time.
+ */
+import type { Duration } from 'moment';
+import { TypedRangeTextComponent } from './TypedRangeTextComponent.d.mts';
+/**
+ * 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<Duration> {
+    /**
+     * Creates a new time component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to a time.
+     *
+     * @param str - The string to convert.
+     * @returns The date.
+     */
+    valueFromString(str: string): Duration;
+    /**
+     * Converts a time to a string.
+     *
+     * @param value - The time to convert.
+     * @returns The string.
+     */
+    valueToString(value: Duration): string;
+}

package/dist/lib/esm/obsidian/Components/TypedRangeTextComponent.d.mts

@@ -1 +1,31 @@
-export * from '../../../cjs/obsidian/Components/TypedRangeTextComponent.cjs';
+/**
+ * @packageDocumentation TypedRangeTextComponent
+ * Contains a component that displays and edits a text-based value with a range.
+ */
+import type { TypedTextComponent } from './TypedTextComponent.d.mts';
+/**
+ * A component that displays and edits a text-based value with a range.
+ */
+export declare abstract class TypedRangeTextComponent<T> extends TypedTextComponent<T> {
+    /**
+     * Sets the maximum value of the component.
+     *
+     * @param max - The maximum value.
+     * @returns The component.
+     */
+    setMax(max: T): this;
+    /**
+     * Sets the minimum value of the component.
+     *
+     * @param min - The minimum value.
+     * @returns The component.
+     */
+    setMin(min: T): this;
+    /**
+     * Sets the step value of the component.
+     *
+     * @param step - The step value.
+     * @returns The component.
+     */
+    setStep(step: number): this;
+}

package/dist/lib/esm/obsidian/Components/TypedTextComponent.d.mts

@@ -1 +1,84 @@
-export * from '../../../cjs/obsidian/Components/TypedTextComponent.cjs';
+/**
+ * @packageDocumentation TypedTextComponent
+ * Contains a component that displays and edits a text-based value.
+ */
+import type { ValueComponent } from 'obsidian';
+import type { MaybePromise } from '../../Async.d.mts';
+import type { ValidatorElement } from '../../HTMLElement.d.mts';
+import type { ValidatorComponent } from './ValidatorComponent.d.mts';
+import type { ValueComponentWithChangeTracking } from './ValueComponentWithChangeTracking.d.mts';
+import type { CssClass } from '../../CssClass.d.mts';
+/**
+ * A component that displays and edits a text-based value.
+ */
+export declare abstract class TypedTextComponent<T> extends ValueComponent<T> implements ValidatorComponent, ValueComponentWithChangeTracking<T> {
+    /**
+     * The input element of the component.
+     */
+    readonly inputEl: HTMLInputElement;
+    /**
+     * The validator element of the component.
+     */
+    get validatorEl(): ValidatorElement;
+    private readonly textComponent;
+    /**
+     * Creates a new typed text component.
+     *
+     * @param containerEl - The container element of the component.
+     * @param type - The type of the input element.
+     * @param cssClass - The CSS class of the component.
+     */
+    constructor(containerEl: HTMLElement, type: string, cssClass: CssClass);
+    /**
+     * Gets the value of the component.
+     *
+     * @returns The value of the component.
+     */
+    getValue(): T;
+    /**
+     * Sets the callback function to be called when the component is changed.
+     *
+     * @param callback - The callback function to be called when the component is changed.
+     * @returns The component.
+     */
+    onChange(callback: (value: T) => MaybePromise<void>): this;
+    /**
+     * Called when the component is changed.
+     */
+    onChanged(): void;
+    /**
+     * Sets the disabled state of the component.
+     *
+     * @param disabled - Whether the component is disabled.
+     * @returns The component.
+     */
+    setDisabled(disabled: boolean): this;
+    /**
+     * Sets the placeholder of the component.
+     *
+     * @param placeholder - The placeholder to set.
+     * @returns The component.
+     */
+    setPlaceholder(placeholder: string): this;
+    /**
+     * Sets the value of the component.
+     *
+     * @param value - The value to set.
+     * @returns The component.
+     */
+    setValue(value: T): this;
+    /**
+     * Converts a string to a value.
+     *
+     * @param str - The string to convert.
+     * @returns The value.
+     */
+    abstract valueFromString(str: string): T;
+    /**
+     * Converts a value to a string.
+     *
+     * @param value - The value to convert.
+     * @returns The string.
+     */
+    valueToString(value: T): string;
+}

package/dist/lib/esm/obsidian/Components/UrlComponent.d.mts

@@ -1 +1,29 @@
-export * from '../../../cjs/obsidian/Components/UrlComponent.cjs';
+/**
+ * @packageDocumentation UrlComponent
+ * Contains a component that displays and edits an url.
+ */
+import type { TypedTextComponent } from './TypedTextComponent.d.mts';
+/**
+ * A component that displays and edits an url.
+ *
+ * You can add this component using {@link SettingEx.addUrl}.
+ *
+ * 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 UrlComponent extends TypedTextComponent<string> {
+    /**
+     * Creates a new Url component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to an url.
+     *
+     * @param str - The string to convert.
+     * @returns The url.
+     */
+    valueFromString(str: string): string;
+}

package/dist/lib/esm/obsidian/Components/ValidatorComponent.d.mts

@@ -1 +1,22 @@
-export * from '../../../cjs/obsidian/Components/ValidatorComponent.cjs';
+/**
+ * @packageDocumentation ValidatorComponent
+ * Contains a component that has a validator element.
+ */
+import type { BaseComponent } from 'obsidian';
+import type { ValidatorElement } from '../../HTMLElement.d.mts';
+/**
+ * A component that has a validator element.
+ */
+export interface ValidatorComponent {
+    /**
+     * The validator element of the component.
+     */
+    readonly validatorEl: ValidatorElement;
+}
+/**
+ * Gets a validator component related to the base component
+ *
+ * @param baseComponent - A base component
+ * @returns related validator component or `null` if no related validator component is found
+ */
+export declare function getValidatorComponent(baseComponent: BaseComponent): null | ValidatorComponent;