Skip to content

DateTimeComponent

A component that displays and edits a date and time.

You can add this component using SettingEx.addDateTime.

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 { DateTimeComponent } from 'obsidian-dev-utils/obsidian/setting-components/date-time-component';

Signature:

export class DateTimeComponent extends TypedRangeTextComponent<Date>

Extends: TypedRangeTextComponent<Date>

Constructor

new DateTimeComponent(containerEl: HTMLElement)

Creates a new date and time component.

Methods

MethodReturnsDescription
setMax(max)thisSets the maximum value of the component.
(Inherited from TypedRangeTextComponent)
setMin(min)thisSets the minimum value of the component.
(Inherited from TypedRangeTextComponent)
setStep(step)thisSets the step value of the component.
(Inherited from TypedRangeTextComponent)
valueFromString(str)DateConverts a string to a date.
valueToString(value)stringConverts a date to a string.

Links to this page: