Keel v0.5.1 English GitHub

Tooltip

在线示例:这是真实的 Keel 程序编译成 WebAssembly,可以直接操作。首次加载约 10 MB。全屏打开
示例代码Go · 可复制

这是上方组件库展示案例的完整源码。examples/components/tooltip.go

在脚手架项目中复用组件构造和 Render 写法;示例的 registerSection 与共享辅助函数由组件库提供。

package main

import (
	"github.com/dyike/keel/ui/core"
	"github.com/dyike/keel/ui/el"
	"github.com/dyike/keel/ui/kit"
)

func init() {
	registerSection("tooltip", "overlays", func() core.Widget { return el.Root(newTooltipGallery()) })
}

type tooltipGallery struct{ copy, save *kit.TooltipView }

func newTooltipGallery() *tooltipGallery {
	core.Bind("gallery.save", "mod+s")
	return &tooltipGallery{
		copy: kit.WithTooltip(kit.Button("", nil).Name(demoText("Copy", "复制")).Icon(kit.IconCopy).Variant(kit.ButtonGhost), demoText("Copy (⌘C)", "复制 Copy(⌘C)")),
		save: kit.WithTooltip(kit.Button(demoText("Save", "保存"), nil), demoText("Save locally", "保存到本地")).Action("gallery.save").Placement(el.Bottom, el.Start).Offset(8).
			Content(el.ViewFunc(func(*el.Context) el.Element {
				return el.Div().Gap(4).Child(el.Text(demoText("Save", "保存")).Bold(), el.Text(demoText("Keep up to 30 versions", "最多保留 30 个版本")))
			})),
	}
}

func (g *tooltipGallery) Render(cx *el.Context) el.Element {
	return el.Div().P(48).Gap(16).Items(el.Start).Child(
		el.Text(demoText("Tooltip: hover for 0.5 seconds to show, focus with Tab to show immediately, or press Esc to hide.", "Tooltip:悬停 0.5 秒显示,Tab 聚焦立即显示,Esc 隐藏")).Bold(),
		el.Div().Row().Gap(12).Child(g.copy.Render(cx), g.save.Render(cx)),
	)
}

给任意视图加一句简短提示。

copy := kit.WithTooltip(kit.Button("", doCopy).Icon(kit.IconCopy), "复制(⌘C)")
  • 什么时候显示:指针停留 kit.TooltipDelay(500ms)后显示;键盘焦点进入被包裹的视图时立即显示。
  • 什么时候隐藏:指针移开、焦点离开、按 Esc。按 Esc 隐藏后,要等指针和焦点都离开一次,才会再次显示。
  • 显示位置:默认在上方居中,放不下时翻到下方。
  • 提示本身不能获得焦点,也不响应点击。
  • SetText 用来更新提示文字,比如复制后改成"已复制"。

Agent:角色是 tooltip,名字是提示文字;富内容和动作键位作为子元素列出。

验证:go run ./examples/components -section tooltip。

悬停延迟绑定到实际可见且启用的目标,移开、禁用或模态遮挡会停止等待;恢复后重新等待完整延迟。SetDisabled(true) 同时禁用提示和目标区域。提示宽度会受当前窗口限制。多个 Tooltip 的延迟独立计算,不沿用上一个目标的等待时间。

Content(view) 替换显示内容,支持多行文字、图标等;原 text 保留为语义名称,必须非空。传 nil 恢复纯文字。富内容中的控件禁用,不会取得焦点或执行点击;需要交互的预览请用 HoverCard。

Action(name) 显示 core.Bind 中该动作的第一个快捷键,自动跟随改绑;未绑定时不显示,不负责注册或执行动作。Placement(side, align) 设置方向和对齐,Offset(dp) 设置间距(默认 4dp,忽略非有限值);定位仍受窗口边缘避让约束。