PropertyPropertyWidgetComponentComboBox

Unofficial

Both Official Unofficial

Both Own Inherited

Combobox component for PropertyPropertyWidgetComponent.

Import:

import type { PropertyPropertyWidgetComponentComboBox } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface PropertyPropertyWidgetComponentComboBox extends PopoverSuggest<PropertyPropertyWidgetComponentComboBoxItem>

Extends: PopoverSuggest<PropertyPropertyWidgetComponentComboBoxItem>

Constructor

new PropertyPropertyWidgetComponentComboBox(app: App, scope?: Scope | undefined)

Constructor.

To extract the constructor type, use ExtractConstructor<PopoverSuggest>.

Properties

	Property	Type	Description
	_items	PropertyPropertyWidgetComponentComboBoxItem[]	The items of the combobox.
	app	App	The Obsidian app instance. (Inherited from PopoverSuggest)
	bgEl	HTMLDivElement	The background element of the combobox.
	buttonEl	HTMLDivElement	The button element of the combobox.
	clearable	boolean	Whether the combobox is clearable.
	iconEl	HTMLDivElement	The icon element of the combobox.
	isOpen	boolean	Whether the suggestion popup is currently open and visible. (Inherited from PopoverSuggest)
	labelEl	HTMLDivElement	The label element of the combobox.
	scope	Scope	The scope for the keymaps. (Inherited from PopoverSuggest)
	searchComponent	SearchComponent	The search component of the combobox.
	suggestEl	HTMLDivElement	Suggestion container element. (Inherited from PopoverSuggest)
	suggestInnerEl	HTMLElement	The inner element holding the rendered suggestions. (Inherited from PopoverSuggest)
	suggestions	SuggestionContainer<PropertyPropertyWidgetComponentComboBoxItem>	Handles selection and rendering of the suggestions. (Inherited from PopoverSuggest)
	value	null | PropertyPropertyWidgetComponentComboBoxItem	The current value of the combobox.
	win	null | Window	The window the suggestion popover is shown in, or null while closed. (Inherited from PopoverSuggest)

Methods

	Method	Returns	Description
	_onClose()	void	Callback for PropertyPropertyWidgetComponentComboBox.onClose.
	_onOpen()	void	Callback for PropertyPropertyWidgetComponentComboBox.onOpen.
	attachDom()	void	Attach the DOM of the combobox.
	autoDestroy()	void	Automatically destroy the popover when its associated element is removed. (Inherited from PopoverSuggest)
	close()	void	Closes the popover. (Inherited from PopoverSuggest)
	detachDom()	Promise<void>	Detach the DOM of the combobox.
	focus()	void	Focus the combobox.
	getItems()	PropertyPropertyWidgetComponentComboBoxItem[]	Get the items of the combobox.
	getSuggestions(query)	SearchResult[]	Callback for PropertyPropertyWidgetComponentComboBox.getSuggestions.
	onClose(callback)	this	Register a callback for close event.
	onEscapeKey()	void	Handle the escape key to close the popover. (Inherited from PopoverSuggest)
	onHistoryBack()	void	Called when the user navigates back in the history. (Inherited from PopoverSuggest)
	onHistoryForward()	void	Called when the user navigates forward in the history. (Inherited from PopoverSuggest)
	onInputChange(query)	void	Handle the input change event of the combobox.
	onOpen(callback)	this	Register a callback for open event.
	onSelect(callback)	this	Register a callback for select event.
	open()	void	Opens the popover. (Inherited from PopoverSuggest)
	renderLabel()	void	Render the label of the combobox.
	renderSuggestion(value, el)	void	Render the suggestion. (Inherited from PopoverSuggest)
	reposition(rect, textDirection?)	void	Reposition the popover relative to the given bounding rectangle. (Inherited from PopoverSuggest)
	selectCb(item)	void	Callback for PropertyPropertyWidgetComponentComboBox.onSelect.
	selectSuggestion(value, evt)	void	Select the suggestion. (Inherited from PopoverSuggest)
	setAutoDestroy(el)	void	Set the element that triggers automatic destruction of the popover when removed. (Inherited from PopoverSuggest)
	setClearable(clearable)	this	Set the clearable state of the combobox.
	setItems(items)	this	Set the items of the combobox.
	setPlaceholder(placeholder)	this	Set the placeholder of the combobox.
	setValue(value)	this	Set the value of the combobox.
	setValueById(id)	this	Set the value of the combobox by its id.
	toggle()	unknown	Toggle the combobox.
	updateValue(value)	this	Update the value of the combobox.

---

Links to this page:

• PropertyPropertyWidgetComponent
• PropertyPropertyWidgetComponentComboBoxItem