ExtraButtonComponent

Defined in: obsidian.d.ts:1459

Extends

BaseComponent

Constructors

new ExtraButtonComponent()

new ExtraButtonComponent(containerEl): ExtraButtonComponent

Defined in: obsidian.d.ts:1468

Parameters

Properties

changeCallback()?

optional changeCallback: () => void

Defined in: src/obsidian/augmentations/Components/ExtraButtonComponent.d.ts:9

The function that’s called after clicking the button.

Returns

void

disabled

disabled: boolean

Defined in: obsidian.d.ts:423

Inherited from

BaseComponent.disabled

extraSettingsEl

extraSettingsEl: HTMLElement

Defined in: obsidian.d.ts:1463

Methods

onClick()

onClick(callback): this

Defined in: obsidian.d.ts:1486

Parameters

callback

() => any

Returns

this

setDisabled()

setDisabled(disabled): this

Defined in: obsidian.d.ts:1472

Parameters

disabled

boolean

Returns

this

Overrides

BaseComponent.setDisabled

setIcon()

setIcon(icon): this

Defined in: obsidian.d.ts:1482

Parameters

icon

string

ID of the icon, can use any icon loaded with addIcon or from the inbuilt library.

Returns

this

See

The Obsidian icon library includes the Lucide icon library, any icon name from their site will work here.

setTooltip()

setTooltip(tooltip, options?): this

Defined in: obsidian.d.ts:1476

Parameters

string

options?

TooltipOptions

Returns

this

then()

then(cb): this

Defined in: obsidian.d.ts:428

Facilitates chaining

Parameters

cb

(component) => any

Returns

this

Inherited from

BaseComponent.then