Citations
将行内引用标记与可检查的来源条目和链接连接。
适用场景
- 当界面需要以下行为时使用 Citations:将行内引用标记与可检查的来源条目和链接连接。
安装
选择安装方式,用法示例将同步更新导入路径。
$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/citations.json
首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。
示例
预览
packages/vue/src/agents/citations/demo.vue
<script setup lang="ts">
import { onBeforeUnmount, onMounted, ref } from "vue";
import { FileText, RotateCcw } from "lucide-vue-next";
import { Citation, Citations, type CitationItem } from "@/components/orvui/agents/citations";
const citations: CitationItem[] = [
{
id: "motion",
title: "Motion documentation",
domain: "motion.dev",
url: "https://motion.dev/docs/vue",
},
{
id: "wai",
title: "WAI accessibility patterns",
domain: "w3.org",
url: "https://www.w3.org/WAI/ARIA/apg/",
},
{
id: "guidelines",
title: "Motion guidelines",
domain: "Design handbook · PDF",
icon: FileText,
},
];
const visible = ref(0),
run = ref(0);
let epoch = 0;
const scheduledTasks = new Set<ReturnType<typeof setTimeout>>();
function cancel() {
epoch++;
scheduledTasks.forEach(clearTimeout);
scheduledTasks.clear();
}
function later(milliseconds: number, task: () => void) {
const version = epoch;
const handle = setTimeout(() => {
scheduledTasks.delete(handle);
if (version === epoch) task();
}, milliseconds);
scheduledTasks.add(handle);
}
onBeforeUnmount(cancel);
function replay() {
cancel();
run.value++;
visible.value = 0;
if (matchMedia("(prefers-reduced-motion: reduce)").matches) {
visible.value = citations.length;
return;
}
citations.forEach((_, index) =>
later(500 + index * 700, () => {
visible.value = index + 1;
}),
);
}
onMounted(replay);
</script>
<template>
<div class="relative h-[410px] w-full max-w-lg">
<div :key="run" class="space-y-4">
<p class="text-sm leading-6 text-foreground/90">
Use layout-aware motion for newly appended results
<Citation citation-id="motion" :index="1" id-prefix="preview-source" />
and preserve accessible disclosure behavior
<Citation citation-id="wai" :index="2" id-prefix="preview-source" /> as
the list grows, keeping exits shorter than entrances
<Citation
citation-id="guidelines"
:index="3"
id-prefix="preview-source"
label="Citation 3: Motion guidelines"
/>.
</p>
<Citations
id-prefix="preview-source"
:citations="citations.slice(0, visible)"
default-open
/>
</div>
<button
type="button"
@click="replay"
class="absolute bottom-0 left-0 inline-flex items-center gap-1.5 rounded-md px-2 py-1 text-xs font-medium text-muted-foreground outline-none transition-colors hover:bg-muted hover:text-foreground focus-visible:ring-2 focus-visible:ring-ring"
>
<RotateCcw class="size-3" />Replay
</button>
</div>
</template>
packages/vue/src/agents/citations/src/Citation.vue
组合结构
使用公开部件 Citation, Citations, CitationList, CitationFavicon 组合 Citations,并从该组件的公开入口导入。
StreamingResponse
├── Citation
└── Citations
├── CitationStack
└── CitationList说明: Streaming Response 组合持续变化的助手回复,包括文字、附件、引用和操作。 Message 使用内容、附件、来源与操作部件组合会话条目。
工作方式
将行内引用标记与可检查的来源条目和链接连接。
状态与事件
需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。
| 组件 | Vue 绑定 | 更新事件 |
|---|---|---|
Citations | v-model:openboolean | update:open |
可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。
API 参考
Citation
citationIdstring—indexnumber—idPrefixstring—label?string—Citations
citationsCitationItem[]—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>"Sources"open?booleanundefineddefaultOpen?booleanfalseidPrefix?string—事件
update:open[open: boolean]@update:openopenChange[open: boolean]@openChangeCitationList
citationsCitationItem[]—idPrefix?string`citation-list-${instanceId.replace(/:/g, "")}`CitationFavicon
url?string—icon?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>—无障碍
为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。
常见问题
- 如何配置 Citations?
- 通过 citationId、index、idPrefix、label 配置 Citations;API 表列出其类型与默认值。
- 如何连接到应用状态?
- 通过文档中的组合方式提供内容,应用副作用由调用方管理。
- 可以在服务端渲染吗?
- 可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。
更新于
来源与许可 ↗MIT · 0.1.1