BasesToggleOption

Official

Both Official Unofficial

Both Own Inherited

Toggle option.

Import:

import type { BasesToggleOption } from 'obsidian';

Signature:

export interface BasesToggleOption extends BasesOption

Extends: BasesOption

Properties

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