TelephoneComponent
A component that allows the user to enter a telephone number.
It looks like regular text component on desktop but changes keyboard to digits only on mobile.
You can add this component using SettingEx.addTelephone.
In order to add the styles for the component, use initPluginContext in your plugin’s onload() function.
Alternatively, you can copy styles from https://github.com/mnaoumov/obsidian-dev-utils/releases/latest/download/styles.css.
Import:
import { TelephoneComponent } from 'obsidian-dev-utils/obsidian/setting-components/telephone-component';Signature:
export class TelephoneComponent extends TypedTextComponent<string> implements TextBasedComponent<string>Extends: TypedTextComponent<string>
Implements: TextBasedComponent<string>
Constructor
new TelephoneComponent(containerEl: HTMLElement)Creates a new telephone component.
Properties
| Property | Type | Description |
|---|---|---|
| inputEl | HTMLInputElement | An input element of the component. (Inherited from TypedTextComponent) |
| textComponent | TextComponent | The inner text component. (Inherited from TypedTextComponent) |
Methods
| Method | Returns | Description |
|---|---|---|
| empty() | void | Empties the component. |
| getValue() | string | Gets the value of the component. (Inherited from TypedTextComponent) |
| isEmpty() | boolean | Checks if the component is empty. |
| onChange(callback) | this | Sets the callback function to be called when the component is changed. (Inherited from TypedTextComponent) |
| onChanged() | void | Called when the component is changed. (Inherited from TypedTextComponent) |
| setDisabled(disabled) | this | Sets the disabled state of the component. (Inherited from TypedTextComponent) |
| setPlaceholderValue(placeholderValue) | this | Sets the placeholder value of the component. |
| setPlaceholderValue(placeholderValue) | this | Sets the placeholder value of the component. (Inherited from TextBasedComponent) |
| setValue(value) | this | Sets the value of the component. (Inherited from TypedTextComponent) |
| valueFromString(str) | string | Gets the value from a string. |
| valueToString(value) | string | Converts a value to a string. (Inherited from TypedTextComponent) |
Links to this page: