OpenDialogOptions

Unofficial

Both Official Unofficial

Both Own Inherited

Options for opening an interactive dialog in the editor (e.g., Vim command line).

Import:

import type { OpenDialogOptions } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface OpenDialogOptions

Properties

	Property	Type	Description
	bottom	number	Whether to display the dialog at the bottom of the editor.
	closeOnBlur	boolean	Whether to close the dialog when it loses focus.
	closeOnEnter	boolean	Whether to close the dialog when the Enter key is pressed.
	selectValueOnOpen	boolean	Whether to select the input value when the dialog opens.
	value	string	Initial value for the dialog input.

Methods

	Method	Returns	Description
	onClose(div)	void	Callback invoked when the dialog is closed.
	onInput(e, value, callback)	void	Callback invoked when the dialog input value changes.
	onKeyDown(e, value, callback)	void	Callback invoked when a key is pressed down in the dialog.
	onKeyUp(e, value, callback)	void	Callback invoked when a key is released in the dialog.