An open API service indexing awesome lists of open source software.

https://github.com/stuartleeks/toast

A go package for Windows 10 toast notifications
https://github.com/stuartleeks/toast

Last synced: about 1 year ago
JSON representation

A go package for Windows 10 toast notifications

Awesome Lists containing this project

README

          

# Toast

This repo contains a fork of the original [go-toast/toast](https://github.com/go-toast/toast) with the following changes:
* Added go mod support
* Updated `toast` CLI to not display console window
* Added [VS Code dev contaier](https://code.visualstudio.com/docs/remote/containers)

A go package for Windows 10 toast notifications.

As seen in [jacobmarshall/pokevision-cli](https://github.com/jacobmarshall/pokevision-cli).

## CLI

As well as using go-toast within your Go projects, you can also utilise the CLI - for any of your projects.

Download the [latest release](https://github.com/stuartleeks/toast/releases/latest) and extract `toast.exe`

```cmd
C:\Users\Example\Downloads\toast.exe \
--app-id "Example App" \
--title "Hello World" \
--message "Lorem ipsum dolor sit amet, consectetur adipiscing elit." \
--icon "C:\Users\Example\Pictures\icon.png" \
--audio "default" --loop \
--duration "long" \
--activation-arg "https://google.com" \
--action "Open maps" --action-arg "bingmaps:?q=sushi" \
--action "Open browser" --action-arg "http://..."
```

![CLI](./screenshot-cli.png)

## Example

```go
package main

import (
"log"

"gopkg.in/toast.v1"
)

func main() {
notification := toast.Notification{
AppID: "Example App",
Title: "My notification",
Message: "Some message about how important something is...",
Icon: "go.png", // This file must exist (remove this line if it doesn't)
Actions: []toast.Action{
{"protocol", "I'm a button", ""},
{"protocol", "Me too!", ""},
},
}
err := notification.Push()
if err != nil {
log.Fatalln(err)
}
}
```

## Screenshots

![Toast](./screenshot-toast.png)

![Action centre](./screenshot-action-centre.png)