Toast

提供不打断操作的状态通知。

实时预览

正在加载预览…

参数配置

全部字段 14

ToastOptions

Styles · 0
列表项 · 0

Go 代码

Go
// Inside a view; c is *ui.Context, t is nui.Theme.
nui.Button(c.Key("notify"), t, "Show notification", nui.ButtonOptions{}).OnClick(func() {
	nui.Toast(c, t, nui.ToastOptions{Title: "Saved successfully", Description: "The example stays entirely in your browser.", Color: nui.ColorDefault, Timeout: 4 * time.Second})
})

使用说明

点击 Show notification 创建一条本地通知,通知在四秒后结束。修改标题和颜色会影响下一条通知;通知应由用户操作或任务结果触发,避免在视图重建时反复创建。

API 参考

Toast

源码
func Toast(c *ui.Context, t Theme, o ToastOptions) string

ToastOptions

源码
type ToastOptions struct {
	ID, Title, Description, Action string
	Color                          Color
	Icon                           *ui.SVG
	Timeout                        time.Duration
	OnAction, OnClose              func()
	UI                             Styles
	Orientation                    Optional[Orientation]
	Close, Progress                Optional[bool]
	Actions                        []ToastActionOptions
}
字段类型说明
IDstring

Go 零值: ""

唯一且稳定的业务标识。

Titlestring

Go 零值: ""

标题文字。

Descriptionstring

Go 零值: ""

补充说明文字。

Actionstring

Go 零值: ""

通知操作按钮的文字。

ColorColor

Go 零值: ColorDefault

语义颜色;默认值继承主题或组件配色。

Icon*ui.SVG

Go 零值: nil

组件使用的 SVG 图标。

Timeouttime.Duration

Go 零值: 0

通知显示时长;单位为 Go time.Duration。

OnActionfunc()

Go 零值: nil

执行通知操作时通知应用的回调。

OnClosefunc()

Go 零值: nil

关闭组件时通知应用的回调。

UIStyles

Go 零值: zero value

以部件名称为键覆盖外观和间距。

OrientationOptional[Orientation]

Go 零值: unset

水平或垂直方向;未设置时使用组件默认方向。

CloseOptional[bool]

Go 零值: unset

操作是否关闭通知,或是否显示关闭控件。

ProgressOptional[bool]

Go 零值: unset

显示通知倒计时进度。

Actions[]ToastActionOptions

Go 零值: nil

附加操作或操作区域构建函数。