TypedDropdownComponent<T>
A dropdown component that can be used to select a value from a list.
You can add this component using SettingEx.addTypedDropdown.
In order to add the styles for the component, use initPluginContext in your plugin’s onload() function.
Alternatively, you can copy styles from https://unpkg.com/@mnaoumov/obsidian-lib/dist/styles.css.
Import:
import { TypedDropdownComponent } from '@mnaoumov/obsidian-lib/setting-components/typed-dropdown-component';Signature:
export class TypedDropdownComponent<T> extends ValueComponent<null | T> implements ValueComponentWithChangeTracking<null | T>Extends: ValueComponent<null | T>
Implements: ValueComponentWithChangeTracking<null | T>
Constructor
new TypedDropdownComponent(containerEl: HTMLElement)Creates a new multiple dropdown component.
Properties
| Property | Type | Description |
|---|---|---|
| dropdownComponent | DropdownComponent | The inner dropdown component. |
| onChange | (callback: (newValue: null | T) => void) => this | Sets a callback function to be called when the value of the component changes. (Inherited from ValueComponentWithChangeTracking) |
| values | T[] | The list of selectable option values, indexed by their position in the dropdown. |
Methods
| Method | Returns | Description |
|---|---|---|
| addOption(value, display) | this | Adds an option to the dropdown. |
| addOptions(options) | this | Adds multiple options to the dropdown. |
| getValue() | null | T | Gets the value of the component. |
| onChange(callback) | this | Sets the callback function to be called when the component is changed. |
| setDisabled(isDisabled) | this | Sets the disabled state of the component. |
| setValue(value) | this | Sets the value of the component. |
| simulateChange__() | void | Simulate a change event. |
Links to this page: