PromptParams

Options for prompt.

Import:

import type { PromptParams } from '@mnaoumov/obsidian-lib/modals/prompt';

Signature:

export interface PromptParams extends ModalParamsBase

Extends: ModalParamsBase

Properties

Property	Type	Description
app	App	An Obsidian app instance. (Inherited from ModalParamsBase)
cancelButtonText?	string	A text for the "Cancel" button.
commandBuilder?	ModalCommandBuilder	Extra controls — checkboxes, dropdowns and keyboard shortcuts — rendered as a strip along the bottom of the modal, so a caller gets a text input plus options with no bespoke modal of its own. Hand it a configured ModalCommandBuilder; the modal builds it. The strip is rendered after the buttons, so it sits along the bottom edge where a SuggestModal's instruction bar sits.
commandsRenderMode?	ModalCommandsRenderMode	The way PromptParams.commandBuilder's controls are rendered.
cssClasses?	string[]	A CSS class to apply to the modal. (Inherited from ModalParamsBase)
defaultValue?	string	A default value to pre-fill the input field.
okButtonText?	string	A text for the "OK" button.
placeholder?	string	A placeholder text for the input field.
spellcheckMode?	SpellcheckMode	The mode deciding whether the input is spell-checked. The default is what this modal has always done, so passing nothing changes nothing: the input follows Editor > Spellcheck, like Obsidian's own name-entry surfaces. Pass SpellcheckMode.Off for a box that is really a search field, or SpellcheckMode.AlwaysOn to spell-check it whatever the vault setting says.
title?	DocumentFragment | string	A title of the modal.
valueValidator?	(value: string) => Promisable<MaybeReturn<string>>	A function to validate the input value.

---

Links to this page:

• prompt