Keel v0.5.1 English GitHub

Dialog

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

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

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

package main

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

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

type dialogGallery struct {
	dlg, edit *kit.DialogView
	name, msg string
}

func newDialogGallery() *dialogGallery {
	g := &dialogGallery{dlg: kit.Dialog(""), msg: demoText("No action yet", "还没有操作"), name: demoText("East China Logistics", "华东物流")}
	presets := kit.Menu().Item(demoText("East China Logistics", "华东物流"), "", func() { g.name = demoText("East China Logistics", "华东物流") }).Item(demoText("Northern Trading", "北方商贸"), "", func() { g.name = demoText("Northern Trading", "北方商贸") })
	presets.Trigger(kit.Button(demoText("Customer presets", "客户预设"), presets.Toggle))
	g.edit = kit.Dialog(demoText("Edit customer", "编辑客户")).CloseButton(true).OverlayClosable(false).Body(el.ViewFunc(func(cx *el.Context) el.Element {
		return el.Div().Gap(8).Child(el.Text(demoText("Customer name", "客户名称")).TextSize(13).TextColor(theme.Muted), el.Input().ID("dialog-name").Bind(&g.name), presets.Render(cx))
	})).Footer(
		kit.Button(demoText("Cancel", "取消"), func() { g.edit.SetValue(false) }).Variant(kit.ButtonSecondary),
		kit.Button(demoText("Save", "保存"), func() { g.edit.SetValue(false); g.msg = demoText("Saved: ", "已保存:") + g.name }),
	)
	return g
}

func (g *dialogGallery) Render(cx *el.Context) el.Element {
	return el.Div().P(24).Gap(12).Items(el.Start).Child(
		el.Text(demoText("Dialog: Esc closes it. Focus stays inside the dialog and returns to the trigger when closed.", "Dialog:Esc 关闭,焦点限制在对话框内,关闭后回到按钮")).Bold(),
		el.Div().Row().Wrap().Gap(8).Child(
			kit.Button(demoText("Confirm", "确认"), func() {
				g.dlg.Icon(kit.IconNone).Confirm(demoText("Save changes", "保存修改"), demoText("Save 3 changes before leaving?", "离开前保存 3 处修改吗?"), func() { g.msg = demoText("Confirmed", "已确认") })
			}).Size(galleryTouchSize(cx)).Render(cx),
			kit.Button(demoText("Delete", "删除"), func() {
				g.dlg.Icon(kit.IconWarning).ConfirmDanger(demoText("Delete order", "删除订单"), demoText("Deleting SO-1001 cannot be undone. Clicking the backdrop does not close it; Esc cancels.", "删除 SO-1001 后不能恢复。点遮罩不会关闭,Esc 等于取消。"), demoText("Delete", "删除"), func() { g.msg = demoText("Deleted", "已删除") })
			}).Size(galleryTouchSize(cx)).Variant(kit.ButtonDanger).Render(cx),
			kit.Button(demoText("Hint", "提示"), func() {
				g.dlg.Icon(kit.IconCheck).IconTone(kit.ToneSuccess).Alert(demoText("Export complete", "导出完成"), demoText("36 records exported.", "共 36 条记录 Exported."), nil)
			}).Size(galleryTouchSize(cx)).Variant(kit.ButtonSecondary).Render(cx),
			kit.Button(demoText("Custom", "自定义"), func() { g.edit.SetValue(true) }).Size(galleryTouchSize(cx)).Variant(kit.ButtonSecondary).Render(cx),
		),
		el.Text(g.msg).TextColor(theme.Muted),
		g.dlg.Render(cx), g.edit.Render(cx),
	)
}

模态对话框。打开时页面变暗,不响应指针,焦点限制在对话框内;关闭后焦点回到打开之前的位置。

标准消息:复用同一个实例。

dlg := kit.Dialog("")
dlg.Confirm("保存修改", "离开前保存吗?", save)                  // 取消 / 确定,焦点在确定上
dlg.ConfirmDanger("删除订单", "删除后不能恢复。", "删除", remove)  // 焦点在取消上
dlg.Alert("导出完成", "共 36 条记录。", nil)                      // 只有确定

自定义内容:

edit := kit.Dialog("编辑客户").Body(form).Footer(cancelButton, saveButton).Width(480)
edit.SetValue(true)
  • 两种挂法任选其一:在视图树里渲染 dlg.Render(cx)(原位置不显示任何内容,只声明浮层);或者在回调里调用 dlg.Show(cx),对话框直接挂到窗口根部,不用放进视图树,关闭后自动取下,和 GPUI 的 window.open_dialog 一样。同一个实例不要两种都用。需要 el.Root。
  • 关闭方式:Esc、点击遮罩、取消按钮。关闭时调用 OnClose(fn);标准消息的"确定"不算关闭,只运行它自己的回调。
  • ConfirmDanger 和 Persistent() 的对话框点击遮罩不会关闭,防止误触;Esc 等同于"取消"。
  • 自定义对话框的按钮由调用方提供,按钮回调里自己调用 SetValue(false) 关闭对话框。
  • Value() / SetValue(bool) 读取或设置是否打开;SetTitle 修改标题;Width(dp) 设置宽度,默认 420,窄窗口中不超过窗口宽度。

Agent:普通对话框的角色是 dialog,ConfirmDanger 和 Persistent() 的角色是 alertdialog,名字是标题,里面的元素单独列出。对话框打开期间,快照里看不到下面的页面。

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

对话框限制在窗口内,长正文单独滚动,窄窗口的页脚按钮改为纵向排列;极小窗口允许整个面板滚动。非有限宽度被忽略,Footer 保存视图列表的副本。

SetDisabled(true) 直接关闭,且阻止 SetValue / 标准消息重新打开;不触发用户关闭回调。所在容器禁用、隐藏或不再提供所属元素时,已声明的模态层会请求关闭并调用一次 OnClose。关闭后不会因恢复启用而重新弹出。

正文和页脚可以包含 Menu、Popover 或另一个 Dialog。父浮层先登记,子浮层位于上方;Esc 逐层关闭,每层恢复对应的先前焦点。示例“自定义”里的客户预设用于验证嵌套菜单。

关闭配置可独立设置,并在复用标准消息时保留:

  • Keyboard(false) 禁止 Esc 关闭,仍消耗该键,避免误关下层对话框;默认开启。
  • Overlay(false) 隐藏遮罩颜色,仍阻挡背景操作并约束焦点;默认显示。
  • OverlayClosable(bool) 显式设置外部点击是否关闭,优先于 Persistent/ConfirmDanger 的默认值。
  • CloseButton(true) 显示标题栏关闭按钮,调用与取消/Esc 相同的关闭逻辑。默认隐藏,保留旧布局;按钮名称随语言切换。无标题也能显示。

关闭按钮、标题、正文和页脚使用稳定身份;切换显示配置不会重建正文输入状态。上述配置不限制程序调用 SetValue(false),也不限制自定义 Footer 按钮。

BeforeConfirm(func() bool) 在标准 Confirm / ConfirmDanger / Alert 的确定操作前运行。返回 false 保持打开、保留焦点且不执行原 onOK,适用于同步校验或等待后台任务;返回 true 后按原顺序先关闭再执行 onOK,不调用 OnClose。nil 清除校验,复用标准消息时保留配置。取消/Esc/遮罩/关闭按钮不受此校验影响;自定义 Footer 仍由应用控制。

dlg.BeforeConfirm(func() bool { return formIsValid() })
dlg.Confirm("提交", "确认提交?", submit)

校验回调中若调用 SetValue、SetDisabled 或打开另一条标准消息,旧确认操作不会继续关闭或执行 onOK。校验不会自动启动 goroutine,也不会自动显示加载状态。

BeforeCancel(func() bool) 在 Esc、遮罩、取消按钮和标题关闭按钮执行前运行。false 保持模态与焦点,不调用 OnClose,用户可再次尝试;true 继续原关闭流程。nil 清除,标准消息复用时保留。回调内 SetValue/禁用/替换消息会中止旧取消操作。

程序调用 SetValue(false)、SetDisabled(true) 不经过取消校验。所属元素隐藏、禁用或移除时的浮层清理也绕过校验,并沿用 OnClose 通知;校验不能让脱离视图树的对话框继续存在。底层 el.Layer.BeforeDismiss 提供相同的用户关闭校验入口。

标题图标

Icon(kit.IconWarning) 在标题前显示图标,复用同一个对话框显示不同消息时保留。颜色随语气:ConfirmDanger 默认用危险色,其他默认用提示色,IconTone(kit.ToneSuccess) 等可以指定。Icon(kit.IconNone) 去掉图标。图标只是装饰,不单独播报,标题已经说明意思。

dlg.Icon(kit.IconWarning).ConfirmDanger("删除订单", "删除后不能恢复。", "删除", remove)
dlg.Icon(kit.IconCheck).IconTone(kit.ToneSuccess).Alert("导出完成", "共 36 条记录。", nil)

进退场共用根视图管理的 presence 生命周期。逻辑关闭时立即禁用退场内容并解除模态、释放焦点,画面继续完成短暂退场;中途重开从当前姿态反向,减少动态效果时跳过过渡。Show 挂载持续到退场完成,移除组件会取消生命周期。这些行为位于工作分支,尚未包含在 v0.4.2 中。