Toast Plugin
The Toast plugin shows temporary notifications stacked in a corner of the screen. Each toast has a dismiss button and can include optional action buttons.
Features
- Quick feedback messages for background actions.
- Automatic removal after a timeout.
- Optional action buttons and custom templates.
- Stacked layout with dismiss button by default.
Setup
Register the plugin before starting your app:
import (
core "github.com/rfwlab/rfw/v2/core"
"github.com/rfwlab/rfw/v2/plugins/toast"
)
func main() {
core.RegisterPlugin(toast.New())
}
Usage
Push a notification:
toast.Push("Saved!")
Custom duration:
toast.PushTimed("Short message", 1500)
With options:
toast.PushOptions("Upload complete", toast.Options{
Duration: 5000,
Actions: []toast.Action{{Label: "Undo", Handler: func(){ /* ... */ }}},
})
API Reference
| Function | Description |
|---|---|
toast.New() |
Creates the plugin with a 3s default duration. |
toast.Push(msg string) |
Shows a message for the default duration. |
toast.PushTimed(msg string, d int) |
Shows a message for d ms. |
toast.PushOptions(msg string, opts Options) |
Shows a message with custom options. |
Types
toast.Action– defines an extra button with a label and handler.
toast.Options– configuresDuration,Actions,Template.
Notes
- Messages stack and disappear after their duration or when dismissed.
- Inline styles are used for positioning.
- Override the default template with
Options.Templatefor full customization.