toast

README

Toast

English | 简体中文

Toast is a small Go library for sending desktop notifications from native applications and lightweight tools. It supports macOS, Windows, and JavaScript WASM, with helper utilities for Windows toast click-to-focus workflows.

Features

• Simple toast.Push API with functional options
• macOS notifications through osascript or Objective-C
• Windows toast notifications through Windows Runtime APIs
• Windows protocol activation for clickable toast actions
• Optional Windows focus helper for bringing the originating terminal or app to front
• JavaScript/WASM notification support for browser environments

Install

go get github.com/hellolib/toast

Quick Start

package main

import "github.com/hellolib/toast"

func main() {
    _ = toast.Push("Build finished", toast.WithTitle("Agent Notify"))
}

Platform Examples

macOS

package main

import "github.com/hellolib/toast"

func main() {
    _ = toast.Push("Permission required",
        toast.WithTitle("Agent Notify"),
        toast.WithSubtitle("15:04:05"),
        toast.WithAudio(toast.Submarine),
    )
}

For Objective-C delivery:

_ = toast.Push("Task completed",
    toast.WithTitle("Agent Notify"),
    toast.WithObjectiveC(),
)

Windows

package main

import "github.com/hellolib/toast"

func main() {
    _ = toast.Push("Task completed",
        toast.WithAppID("agent-notify"),
        toast.WithTitle("Agent Notify"),
        toast.WithAudio(toast.Default),
        toast.WithLongDuration(),
    )
}

To add an image:

_ = toast.Push("Task completed",
    toast.WithTitle("Agent Notify"),
    toast.WithIcon(`C:\path\to\icon.png`),
)

JavaScript / WASM

package main

import (
    "fmt"

    "github.com/hellolib/toast"
)

func main() {
    _ = toast.Push("Saved",
        toast.WithTitle("WASM App"),
        toast.WithOnClick(func(event interface{}) {
            fmt.Println("clicked")
        }),
        toast.WithOnClose(func() {
            fmt.Println("closed")
        }),
    )
}

Windows Click-To-Focus

Windows toast clicks are delivered through activation. For ordinary Go command line tools, the practical approach is:

1. Ship a small GUI-subsystem helper executable.
2. Register a custom URL protocol that launches the helper.
3. Send the toast with WithActivationType("protocol").
4. Pass the protocol URI through WithActivationArguments.

This repository provides both the library API and a helper command for that flow. The helper is a separate executable so toast clicks do not flash a console window.

Library Usage

package main

import (
    "fmt"
    "os"

    "github.com/hellolib/toast"
)

func main() {
    focus, err := toast.PrepareFocusActivation(
        os.Getppid(),
        `C:\path\to\toast-focus-helper.exe`,
    )
    if err != nil {
        panic(err)
    }

    _ = toast.Push("Click to focus the current terminal",
        toast.WithAppID("agent-notify"),
        toast.WithTitle("Agent Notify"),
        toast.WithMessage(fmt.Sprintf("helper: %s", focus.Helper)),
        toast.WithActivationType("protocol"),
        toast.WithActivationArguments(focus.Arguments),
    )
}

PrepareFocusActivation checks explicit helper candidates first. If none are provided or found, it looks next to the current executable for conventional names:

• toast-focus-helper.exe
• toast-focus-helper-arm64.exe
• <app>-focus-helper.exe
• <app>-helper.exe

Demo Commands

cmd/toast-focus is a runnable demo that sends a clickable toast. It expects the helper binary to be in the same directory.

make build

Artifacts are written to dist/:

• toast-focus.exe
• toast-focus-helper.exe
• toast-focus-arm64.exe
• toast-focus-helper-arm64.exe

For applications that only need the helper binaries:

make build-helpers

Make Targets

make test                 # Run Go tests
make build                # Build all Windows demo/helper binaries
make build-helpers        # Build only Windows focus helpers
make build-windows-amd64  # Build Windows amd64 demo/helper
make build-windows-arm64  # Build Windows arm64 demo/helper
make clean                # Remove dist/

API Overview

Common options:

• toast.Push(message, opts...)
• toast.WithTitle(title)
• toast.WithMessage(message)
• toast.WithAudio(audio)

macOS options:

• toast.WithSubtitle(subtitle)
• toast.WithObjectiveC()

Windows options:

• toast.WithAppID(appID)
• toast.WithIcon(path)
• toast.WithIconRaw(bytes)
• toast.WithActivationType(kind)
• toast.WithActivationArguments(uri)
• toast.WithProtocolAction(label, uri)
• toast.WithLongDuration()
• toast.WithShortDuration()

Windows focus helpers:

• toast.FindFocusHelper(candidates...)
• toast.RegisterFocusProtocol(helperPath, protocol...)
• toast.PrepareFocusActivation(pid, helperCandidates...)
• toast.FocusActivationArguments(pid, protocol...)

JavaScript/WASM options:

• toast.WithIcon(url)
• toast.WithImage(url)
• toast.WithRequireInteraction(true)
• toast.WithOnClick(fn)
• toast.WithOnShow(fn)
• toast.WithOnClose(fn)
• toast.WithOnError(fn)

License

MIT

Documentation

Index

• Constants
• func FindFocusHelper(_ ...string) (string, error)
• func FocusActivationArguments(pid int, protocols ...string) string
• func Push(message string, opts ...NotificationOption) error
• func RegisterFocusProtocol(_ string, _ ...string) error
• type Audio
• type FocusActivation
  • func PrepareFocusActivation(_ int, _ ...string) (FocusActivation, error)
• type NotificationOption
  • func WithAudio(audio Audio) NotificationOption
  • func WithMessage(msg string) NotificationOption
  • func WithObjectiveC(b ...bool) NotificationOption
  • func WithSubtitle(subtitle string) NotificationOption
  • func WithTitle(title string) NotificationOption

Constants

const (
	// DefaultFocusProtocol is the protocol used by the bundled focus helper.
	DefaultFocusProtocol = "anfocus"
)

Functions

func FindFocusHelper

func FindFocusHelper(_ ...string) (string, error)

FindFocusHelper is only supported on Windows.

func FocusActivationArguments

func FocusActivationArguments(pid int, protocols ...string) string

FocusActivationArguments formats the URI passed to WithActivationArguments.

func Push

func Push(message string, opts ...NotificationOption) error

func RegisterFocusProtocol

func RegisterFocusProtocol(_ string, _ ...string) error

RegisterFocusProtocol is only supported on Windows.

Types

type Audio

type Audio string

const (
	Basso     Audio = "Basso"
	Blow      Audio = "Blow"
	Bottle    Audio = "Bottle"
	Frog      Audio = "Frog"
	Funk      Audio = "Funk"
	Glass     Audio = "Glass"
	Hero      Audio = "Hero"
	Morse     Audio = "Morse"
	Ping      Audio = "Ping"
	Pop       Audio = "Pop"
	Purr      Audio = "Purr"
	Sosumi    Audio = "Sosumi"
	Submarine Audio = "Submarine"
	Tink      Audio = "Tink"
)

type FocusActivation

type FocusActivation struct {
	Protocol  string
	Helper    string
	Arguments string
}

FocusActivation describes the protocol activation data used to focus the source window when a Windows toast is clicked.

func PrepareFocusActivation

func PrepareFocusActivation(_ int, _ ...string) (FocusActivation, error)

PrepareFocusActivation is only supported on Windows.

type NotificationOption

type NotificationOption func(*notification)

func WithAudio

func WithAudio(audio Audio) NotificationOption

WithAudio

The audio to play when displaying the notification

func WithMessage

func WithMessage(msg string) NotificationOption

WithMessage

The single/multi line message to display for the notification.

func WithObjectiveC

func WithObjectiveC(b ...bool) NotificationOption

func WithSubtitle

func WithSubtitle(subtitle string) NotificationOption

func WithTitle

func WithTitle(title string) NotificationOption

WithTitle

The main title/heading for the notification.