Skip to content

TypedRangeTextComponent<T>

A component that displays and edits a text-based value with a range.

Import:

import { TypedRangeTextComponent } from 'obsidian-dev-utils/obsidian/setting-components/typed-range-text-component';

Signature:

export class TypedRangeTextComponent<T> extends TypedTextComponent<T>

Extends: TypedTextComponent<T>

Properties

PropertyTypeDescription
inputElHTMLInputElementAn input element of the component.
(Inherited from TypedTextComponent)
textComponentTextComponentThe inner text component.
(Inherited from TypedTextComponent)

Methods

MethodReturnsDescription
getValue()TGets the value of the component.
(Inherited from TypedTextComponent)
onChange(callback)thisSets the callback function to be called when the component is changed.
(Inherited from TypedTextComponent)
onChanged()voidCalled when the component is changed.
(Inherited from TypedTextComponent)
setDisabled(disabled)thisSets the disabled state of the component.
(Inherited from TypedTextComponent)
setMax(max)thisSets the maximum value of the component.
setMin(min)thisSets the minimum value of the component.
setStep(step)thisSets the step value of the component.
setValue(value)thisSets the value of the component.
(Inherited from TypedTextComponent)
valueFromString(str)TConverts a string to a value.
(Inherited from TypedTextComponent)
valueToString(value)stringConverts a value to a string.
(Inherited from TypedTextComponent)

Links to this page: