Skip to content

ValueComponent<T>

Official

A value component.

Import:

import { ValueComponent } from 'obsidian';

Signature:

export class ValueComponent<T> extends BaseComponent

Extends: BaseComponent

Constructor

new ValueComponent()

Constructor.

To get the constructor instance, use getValueComponentConstructor from obsidian-typings/implementations.

Properties

Property Type Description
disabled boolean Whether the component is disabled.
(Inherited from BaseComponent)

Methods

Method Returns Description
getValue() T Get the value of the component.
registerOptionListener(listeners, key) this Register an option listener.
setDisabled(disabled) this Sets the disabled state of the component.
(Inherited from BaseComponent)
setValue(value) this Set the value of the component.
then(cb) this Facilitates chaining.
(Inherited from BaseComponent)

Links to this page: