Skip to content

PromptParams

Options for prompt.

Import:

import type { PromptParams } from 'obsidian-dev-utils/obsidian/modals/prompt';

Signature:

export interface PromptParams extends ModalParamsBase

Extends: ModalParamsBase

Properties

PropertyTypeDescription
appAppAn Obsidian app instance.
(Inherited from ModalParamsBase)
cancelButtonText?stringA text for the "Cancel" button.
cssClasses?string[]A CSS class to apply to the modal.
(Inherited from ModalParamsBase)
defaultValue?stringA default value to pre-fill the input field.
okButtonText?stringA text for the "OK" button.
placeholder?stringA placeholder text for the input field.
title?DocumentFragment | stringA title of the modal.

Methods

MethodReturnsDescription
valueValidator(this, value)Promisable<MaybeReturn<string>>A function to validate the input value.

Links to this page: