Skip to content

BasesTextOption

Official

Text option.

Import:

import type { BasesTextOption } from 'obsidian';

Signature:

export interface BasesTextOption extends BasesOption

Extends: BasesOption

Properties

PropertyTypeDescription
default?stringDefault value.
displayNamestringDisplay name.
(Inherited from BasesOption)
keystringKey.
(Inherited from BasesOption)
placeholder?stringPlaceholder.
shouldHide?() => booleanIf provided, the option will be hidden if the function returns true.
(Inherited from BasesOption)
type'text'Type.