Approval Card

在助手继续工作前,引导用户完成一个或多个决策步骤。

适用场景

  • 当界面需要以下行为时使用 Approval Card:在助手继续工作前,引导用户完成一个或多个决策步骤。

安装

选择安装方式,用法示例将同步更新导入路径。

$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/approval-card.json

首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。

示例

Questions

questions.vue

逐步完成决策问题,并保留每题答案以便复核。

How focused should the first release be?

1/3
Question 1 of 3

Review and Approve

review.vue

在确认待执行操作前,复核已经收集的答案。

Publish the component update?

Input required

The agent has prepared the release and is waiting for your decision.

Release
approval-card
Checks
4 passed
Visibility
Public registry

组合结构

使用公开部件 ApprovalCard 组合 Approval Card,并从该组件的公开入口导入。

Message
└── MessageContent
    └── ApprovalCard

说明: Tool Approval 为待执行工具操作展示说明,并请求明确决策。 Message 使用内容、附件、来源与操作部件组合会话条目。 Todo List 展示带展开详情和明确任务状态的工作条目序列。

工作方式

在助手继续工作前,引导用户完成一个或多个决策步骤。

状态与事件

需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。

组件状态绑定
组件Vue 绑定更新事件
ApprovalCardv-model:answersApprovalCardAnswersupdate:answers
ApprovalCardv-model:stepnumberupdate:step

可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。

API 参考

Questions

title?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
"Approval required"
description?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
—
questions?
ApprovalCardQuestion[]
() => []
status?
"pending" | "submitting" | "approved" | "rejected" | "changes-requested" | "answered"
"pending"
answers?
ApprovalCardAnswers
—
defaultAnswers?
ApprovalCardAnswers
() => ({})
step?
number
—
defaultStep?
number
0
approveLabel?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
"Approve"
submitLabel?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
"Submit response"
result?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
undefined

事件

update:answers
[answers: ApprovalCardAnswers]
@update:answers
answersChange
[answers: ApprovalCardAnswers]
@answersChange
update:step
[step: number]
@update:step
stepChange
[step: number]
@stepChange
submit
[answers: ApprovalCardAnswers]
@submit
approve
[]
@approve
reject
[]
@reject
requestChanges
[]
@requestChanges
dismiss
[]
@dismiss

插槽

default
() => VNodeChild
#default

Review and Approve

title?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
"Approval required"
description?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
—
questions?
ApprovalCardQuestion[]
() => []
status?
"pending" | "submitting" | "approved" | "rejected" | "changes-requested" | "answered"
"pending"
answers?
ApprovalCardAnswers
—
defaultAnswers?
ApprovalCardAnswers
() => ({})
step?
number
—
defaultStep?
number
0
approveLabel?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
"Approve"
submitLabel?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
"Submit response"
result?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
undefined

事件

update:answers
[answers: ApprovalCardAnswers]
@update:answers
answersChange
[answers: ApprovalCardAnswers]
@answersChange
update:step
[step: number]
@update:step
stepChange
[step: number]
@stepChange
submit
[answers: ApprovalCardAnswers]
@submit
approve
[]
@approve
reject
[]
@reject
requestChanges
[]
@requestChanges
dismiss
[]
@dismiss

插槽

default
() => VNodeChild
#default

无障碍

为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。

常见问题

如何配置 Approval Card?
通过 title、description、questions、status、answers、defaultAnswers、step、defaultStep、approveLabel、submitLabel、result 配置 Approval Card;API 表列出其类型与默认值。
如何连接到应用状态?
监听 update:answers、answersChange、update:step、stepChange、submit、approve、reject、requestChanges、dismiss,将组件连接到应用状态。
可以在服务端渲染吗?
可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。

更新于