Skip to content

ElectronTouchBarButtonConstructorOptions

Unofficial

Options for creating a ElectronTouchBarButton.

Import:

import type { ElectronTouchBarButtonConstructorOptions } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronTouchBarButtonConstructorOptions

Properties

PropertyTypeDescription
accessibilityLabel?stringA short description of the button for use by screen readers like VoiceOver.
backgroundColor?stringButton background color in hex format, i.e #ABCDEF.
enabled?booleanWhether the button is in an enabled state.
icon?ElectronNativeImage | stringButton icon.
iconPosition?'left' | 'overlay' | 'right'Position of the icon.
label?stringButton text.

Methods

MethodReturnsDescription
click()voidCallback invoked when the button is clicked.