Skip to content

BasesTextOption

Official

Text option.

Import:

import type { BasesTextOption } from 'obsidian';

Signature:

export interface BasesTextOption extends BasesOption

Extends: BasesOption

Properties

Property Type Description
default? string Default value.
displayName string Display name.
(Inherited from BasesOption)
key string Key.
(Inherited from BasesOption)
placeholder? string Placeholder.
shouldHide? () => boolean If provided, the option will be hidden if the function returns true.
(Inherited from BasesOption)
type 'text' Type.