BasesPropertyOption

Official

Both Official Unofficial

Both Own Inherited

A dropdown menu allowing selection of a property.

Import:

import type { BasesPropertyOption } from 'obsidian';

Signature:

export interface BasesPropertyOption extends BasesOption

Extends: BasesOption

Properties

	Property	Type	Description
	default?	string	Default value.
	displayName	string	Display name. (Inherited from BasesOption)
	filter?	(prop: BasesPropertyId) => boolean	If provided, only properties which pass the filter will be included for selection in the property dropdown.
	key	string	Key. (Inherited from BasesOption)
	placeholder?	string	Placeholder.
	shouldHide?	() => boolean	If provided, the option will be hidden if the function returns true. (Inherited from BasesOption)
	type	'property'	Type.