hey

package module

v0.0.0-...-4bb9fc0 Latest Latest Go to latest Published: Jun 18, 2022 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/lukechampine/hey

Links

Open Source Insights

README ¶

hey

hey is a tiny library for displaying notifications on Linux.

hey.Push(hey.Notification{
	Title:    "foo",
	Body:     "bar",
	AppName:  "computer",
	Duration: hey.DefaultDuration,
})

Run go test to see an example notification.

Documentation ¶

Index ¶

Constants
type Notification
type NotificationID
- func Push(n Notification) (NotificationID, error)

Constants ¶

View Source

const DefaultDuration = -1 * time.Millisecond

DefaultDuration is the OS's default notification duration.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Notification ¶

type Notification struct {
	Title      string
	Body       string
	AppName    string
	IconPath   string
	Duration   time.Duration // 0 means notification must be dismissed manually
	ReplacesID NotificationID
}

A Notification represents a notification to be shown to the user. Only the Title field is required.

type NotificationID ¶

type NotificationID uint32

NotificationID uniquely identifies a notification.

func Push ¶

func Push(n Notification) (NotificationID, error)

Push displays a notification. It returns a NotificationID that can be used to replace the notification later.

Source Files ¶

View all Source files

hey.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL