BasesFileOption

Official

Both Official Unofficial

Both Own Inherited

A text input allowing selection of a file from in the vault.

Import:

import type { BasesFileOption } from 'obsidian';

Signature:

export interface BasesFileOption extends BasesOption

Extends: BasesOption

Properties

	Property	Type	Description
	default?	string	The default value of the option.
	displayName	string	Display name. (Inherited from BasesOption)
	filter?	(file: TFile) => boolean
	key	string	Key. (Inherited from BasesOption)
	placeholder?	string	The placeholder of the option.
	shouldHide?	() => boolean	If provided, the option will be hidden if the function returns true. (Inherited from BasesOption)
	type	'file'	The type of the option.