obsidian-dev-utils
Version:
This is the collection of useful functions that you can use for your Obsidian plugin development
38 lines (37 loc) • 1.26 kB
text/typescript
/**
* @packageDocumentation
*
* Contains a component that displays and edits multiple email addresses.
*/
import { TypedTextComponent } from './TypedTextComponent.mjs';
/**
* 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<readonly 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): readonly string[];
/**
* Converts an email address to a string.
*
* @param value - The email address to convert.
* @returns The string.
*/
valueToString(value: readonly string[]): string;
}