Skip to content

ElectronDisplayBalloonOptions

Unofficial

Options for ElectronTray.displayBalloon.

Import:

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

Signature:

export interface ElectronDisplayBalloonOptions

Properties

Property Type Description
content string The content of the balloon.
icon? ElectronNativeImage | string Icon to use when iconType is custom.
iconType? 'custom' | 'error' | 'info' | 'none' | 'warning' Can be none, info, warning, error or custom.
largeIcon? boolean The large version of the icon should be used. Maps to NIIF_LARGE_ICON.
noSound? boolean Do not play the associated sound. Maps to NIIF_NOSOUND.
respectQuietTime? boolean Do not display the balloon notification if the current user is in "quiet time". Maps to NIIF_RESPECT_QUIET_TIME.
title string The title of the balloon.