unis-oa/docs/designer-panel-dialogs.md

9.8 KiB
Raw Permalink Blame History

设计器侧栏只留入口,配置摊进弹窗

原话是这一句:「截图所示,配置的地方太宽了导致都展示出界了。帮我把所有配置都变成弹出框 进行配置,这样就不会出现这样的情况。」

截图里是表单设计器那条 320px 的属性栏:「关联带出」那一栏里几只下拉整个撑到卡片右边框 外面去,选项全称被截成「对方表单字段·附件(工作联…)」。这份文档写的是修完之后定下的 那条规矩、SidePanel 这一层的契约、哪些配置进了弹窗、哪些故意没进,以及怎么验。

0. 一页看完

要做的事 在哪儿 点下去到哪儿
改一格的候选来源 / 关联带出 属性栏 → 「候选来源」那一行(角标写来源类型、几项、几条带出) 弹窗:候选来源 + 显示映射 + 关联带出那一整块
改明细表有哪几列 属性栏 → 「列」那一行(角标 N 列 / 共 N 列,其中 M 列必填) 弹窗:那张列编辑器
改联动、外部页面、额度、取数、阈值 属性栏 → 各自那一行 各自的弹窗,面板本体一个字没改
改标题 / 编号的生成规则 属性栏 → 「流程标题生成规则」那一行 弹窗(TitleRulePanel 现在就是 SidePanel 的一层皮)
改一条连线 右栏「连线配置」→ 「添加路由」那一行;画布上直接点那条线,门自己开 弹窗,底下是「应用到画布」
改审批人规则、抄送、字段权限、外部审批、写回、闸门 右栏那一行摘要 → NodeConfigDialog(extra-wide,左列选分组) 不再往里叠一层:见 §3
改一格的名称 / 标识 / 类型 / 占位 / 必填 / 宽度 属性栏里就地改 不进门——单控件,摊得开

贯穿这份改动的三条分寸:

  • 能摊开的都摊到弹窗里,判据不是"这块重不重要",而是"它要不要多列并排"。一只 Select 在 150px 里只能念出前五个字,那就是没摊开。
  • 面板本体一行没改。挪的大多是既有的 *Panel.vue——它们本来就是按整块设计的,只是 换个地方摆。所以没有第二份实现,也没有第二套校验措辞。
  • 不为了统一把单控件也塞进弹窗。改名、勾必填、填标识是一天点几十下的动作,多一次 点击就是真的更难用。窄栏留着它们,弹窗留给表。

1. 溢出那一下的真实原因

弹窗是主修,但撑出去那一截本身是个 bug,也一起修了——就算不进弹窗也不该出界:

  • 声明成 grid-cols-[1fr_1fr] 的网格轨道,隐式 min-width: auto:里面那只下拉的 最小内容宽度大于轨道份额时,1fr 不会收缩,整块被顶宽。改成 grid-cols-[minmax(0,1fr)_minmax(0,1fr)] 才真按份数分。
  • components/common/Select.vue 根节点原来只有 relative,缺 min-w-0,作为弹性/网格 子项时同样不收缩。根上加 min-w-0 是一次性修完所有调用点。

LinkFillPanel.vue、LinkagePanel.vue 里那几处 [1fr_auto] / [1fr_1fr_auto] 一并换成 minmax(0,…) 写法。这三处是防御性的:弹窗里也还是这套布局。

2. SidePanel:入口那一行 + 一扇门

frontend/src/components/oa/design/SidePanel.vue,属性栏那十来块面板与连线那一块共用它。

侧栏那一行只负责三件事:说这是什么配置(标题 + 图标)、现在配成了什么样(摘要 + 角标)、 点一下开门。摘要与角标不是装饰——门关上以后,那一行就是唯一的可见状态;配没配、几条、 哪几格,都要不点开也念得出来。配过的行描成主色(emphasized),一眼扫得出哪些格子动过。

入参 管什么
title / icon 那一行与弹窗标题
summary / badge / emphasized 那一行念出来的三样:现在什么样、几条、有没有配过
intro / hint 弹窗顶上那句说明、底下那句提示
width / contentClass 弹窗宽度与内容宽度上限(窄面板摊在 1100px 里会散,给一道 max-w-*)
reveal 递增一下就把门打开:从工具栏、总览、明细表那一侧跳过来时用
resetKey 变了就把门关着:弹窗开着时点别的格子,门里不该还是上一格的配置
testId 生成 -entry / -open / -badge / -summary / -close 那几个 data-test

三条行为上的定死:

  • 门关着时插槽内容根本不挂载(BaseDialog 里是 v-if)。属性栏一次只选一格,但每格 背后都挂着七八块面板,全都挂载等于每点一格就跑七八趟接口。
  • 改动当场生效,没有「确定 / 取消」。面板们写的都是字段 / 环节上那份配置,画布的未保存 黄点与撤销栈跟着走——和「手机端」「标签页」同一脾气。
  • 要自己摆按钮的用 #footer 具名插槽。连线那一块是唯一的例外:它点「应用到画布」才落到 设计上,不该挂在那句「改动当场生效」下面。宿主自带 footer 时,默认那句提示和那颗「关闭」 都不再出现,免得说错话。

reveal 那条信号是旧口径的延续:从总览弹窗「跳到那一格」以前只负责滚动定位,现在多了 一步——先把门打开,再滚到眼前并描一圈。revealLinkFill + revealLinkFillKey 那对键控 信号(见 relation-link-fill-design.md §2.5)一个字没改, 只是最里面那一层从"就地展开"换成"开门"。

3. 进了弹窗的清单

表单设计器属性栏(320px):候选来源(含显示映射、关联带出)、明细表列编辑器、联动、 外部页面、额度、外部取数、阈值、标题 / 编号生成规则。

流程设计器右栏(352px):连线配置。环节那一侧(条件免审 / 条件必批 / 自动抄送 / 表单 字段权限 / 外部审批 / 写回 / 提交闸门)这一层没动,也不该动:常驻的 352px 那一栏早就 只摆摘要 + 入口(variant="rail" 那一段,一行一句现状,点下去 emit('configure', group)), 进去的是 NodeConfigDialog 那颗 extra-wide 弹窗,左列选分组、右面那一整块面板摊在约 1000px 里。这一层再叠一道弹窗就是弹窗摞弹窗,白多一次点击。同一个规矩,两种满足方式: 判据是"它有没有摊开的地方",不是"它是不是面板"。

本来就是弹窗的:标签页配置(TabsConfigDialog)、手机端版式(MobileLayoutPanel)、 关联带出总览、条件构造器、公式构造器、环节配置弹窗。属性栏里那一栏(TabsPanel、 table-link-fill)只念摘要 + 给跳转按钮,改都交给弹窗——这条规矩在它们身上早就成立了, 这次是把剩下的补齐。

没进弹窗的:名称 / 标识 / 类型 / 占位符 / 必填 / 宽度 / 默认值这些单控件,以及并排两 个数字框那种(金额上下限、星级 + 小数位)。一列放得下,摊进弹窗只是多一次点击。

4. 几处容易踩的地方

  • 嵌套弹窗:连线门里还要开条件构造器,候选来源门里的联动要开条件弹窗。两层都是 BaseDialog 默认 z-50,靠"后挂载的在 body 里排在后面"叠上去,够用;真压不住再显式 给 z-index(InterventionPanel 那种)。
  • Select 的下拉在弹窗里是 fixed 定位、z-index: 100000020,不受 modal 层级影响。
  • 开门不等于选中。reveal 只在递增那一瞬开门,不记状态;resetKey(字段 key 或环节 id)一变就关门,避免"门里是上一格的配置、外面是这一格的名字"。
  • 连线那扇门要 immediate。点画布上那条线是把右栏切到「连线配置」同时带上 id, 面板那一刻是挂载而不是更新,监听器不 immediate 就是第一下不开门。
  • 测试里要 stubs: { teleport: true }。弹窗内容传送到 body,不 stub 就 find 不到; 要摸真的 DOM(焦点、滚动)就照 FormDesignerView.tabs.spec.ts 那样再配一个 attachTo: document.body。窄栏里的面板整块搬进弹窗之后,原来直接 find 面板内部的 测试都要先点一下 *-open 那颗入口——FieldInspector.newTypes.spec.ts 里摸明细表列 编辑器的那一句改的就是这个,open() 之后补一步点击,测试各自钉的行为一个字没动。
  • 别把已经在宽弹窗里的面板再叠一层。环节那一侧八块配置先试过这条路,结果是 NodeConfigDialog 里再摞一道弹窗、点两次才摸到控件,又退回去了(§3 末段)。

5. 怎么验

cd frontend
npx vue-tsc --noEmit
npx eslint src
npx vitest run src/components/oa/design

钉住这条规矩的测试:

测试 钉的是什么
design/SidePanel.spec.ts 门关着时插槽不挂载;点入口开门 / 点关闭关门;reveal 开门;resetKey 关门;宿主自带 footer 时默认那颗关闭与那句提示都退场
design/RouteInspector.spec.ts 窄栏只剩入口;入口那一行念得出「起点 → 终点 · 名字 · 条件」;点连线时门自己开(含挂载那一下);没点「应用到画布」一个字不写;按「删除连线」把门关上
design/FieldInspector.newTypes.spec.ts 明细表列编辑器改成弹窗后,先点入口再摸里面的列选择器
views/oa/design/FormDesignerView.linkFillEntry.spec.ts 光选中那一格看不见带出那一栏(它已在门里),点入口才开门;从总览 / 明细表 / 双击跳过来时门自己开
i18n/localeParity.spec.ts / messageSyntax.spec.ts 新增那批 form.panel* 与 process.route* 文案中英一致、插值语法没错