# @aparte/plugin-artifacts 中文文档

规范地址：https://npmcn.com/package/%40aparte/plugin-artifacts/

版本：0\.32\.1
npm 元数据更新时间：2026-11-02T11:24:37.199Z
中文译文更新时间：2026-11-06T09:00:45.594Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aparte/plugin-artifacts
原文对照：https://npmcn.com/package/%40aparte/plugin-artifacts/?lang=original
项目主页：https://apartejs.dev/components/artifact/
源码仓库：https://github.com/apartejs/aparte

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：287 kB，34 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- peer 依赖：@aparte/core \>=0\.32\.1 \<1\.0\.0
- 首次发布：2026-08-29T21:00:58.075Z
- 最新版本发布：2026-11-02T11:24:36.740Z
- 近 30 天下载量：5115（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 46 个）

## 中文简介

Attifacts for parté ——一个模型调用的一个创建 artifact工具,一个丰富的代码/预览卡,使其产生结果,以及一个在取出中写出一个的模型的标记语法.

## 安装

```sh
npm install @aparte/plugin-artifacts
```

也可以使用：`pnpm add @aparte/plugin-artifacts`、`yarn add @aparte/plugin-artifacts`、`bun add @aparte/plugin-artifacts`

## README

# @ aparte/ 插件艺术

用于 [独立](https://github.com/apartejs/aparte):模型产生的文档——一页,一页 组件,一个脚本,一个SVG,一个Markdown便条,一个电子表格——显示为代码/预览卡 记录 一件艺术品是公约 应用程序教它的模型 而不是一个模型做的 大自然,所以整个大会 生活在这里: `create_artifact` **工具** 模型调用 **纸牌** 产生结果 `<artifact>` **标记语法** 一个写一个的模型 在它的传言.

```bash
npm install @aparte/plugin-artifacts @aparte/core
```

```ts
import { setupArtifacts } from '@aparte/plugin-artifacts';

setupArtifacts(); // registers the tool, its renderer, the grammar and the segment renderer
```

`@aparte/core` 是唯一一个 **同伴依赖**。 。 。 .

## 选项

```ts
setupArtifacts({
  name: 'create_artifact',        // the tool's name as the model sees it
  systemPrompt: false,            // your own string, or false to send none
  tag: 'artifact',                // the tag recognised in the prose; false for none
  preview: true,                  // false: no Preview tab; a function: your own srcdoc builder
  onBinary: async (artifact) => { // pdf / xlsx / docx: produce the file from the model's source
    const { buffer, filename } = await runInYourSandbox(artifact.content);
    return { buffer, filename, mime: artifact.mimeType };
  },
});
```

第二次辩论将所有事情都扩大到一个 `AparteConfig` 而不是全球性的 电话 返回取消所有四个注册的函数.

## 那张牌是做什么的

-   打开 **代码**,通过任意突出显示核心突出显示.
-   **预览** 用于 `html`, (中文(简体) ), `react`, (中文(简体) ), `svg`, (中文(简体) ), `js` 财务报告和审定财务报表 `css` ——只有在读者时才挂载 按下标签:一个可预览的文物是模式作者代码,并挂起它 执行它。 这个框架是 `sandbox="allow-scripts"` 和一个CSP,让任何东西都出.
-   **复制** 财务报告和审定财务报表 **下载** 每件文字文物上; 二进制一(`pdf`, (中文(简体) ), `xlsx`, (中文(简体) ), `docx`(中文(简体) ) 只下载一次 `onBinary` 因为没有按钮 库中没有字节.
-   只有一个电话显示卡片。 一个在等待一个人的认可 是这样说的,一个是 拒绝,停止或失败显示其标题和"没有创建",没有任何内容可以复制或下载.

## 两道入道,一张牌

工具调用模型 `create_artifact` 与 `{ mimeType, title, content }`; 处理器 返回文档,作为工具的结构结果,并从中绘制出卡片。 一个模型 没有工具写入 `<artifact type="text/html" title="…">…</artifact>` 在答复中; 核心 parser – 通过此插件教授语法 `registerStreamBlock` - 它流入一个 `artifact` 同一纸牌的片段.

MIME 类型遵循标准,加上 Anthropic 类型 `application/vnd.ant.*` 名称空间 框架类型(`application/vnd.ant.react`) (中文(简体) ). `deriveArtifactKind(mimeType)` 给出短 将卡开关打开.

## 常见问题

### @aparte/plugin-artifacts 是什么？

Attifacts for parté ——一个模型调用的一个创建 artifact工具,一个丰富的代码/预览卡,使其产生结果,以及一个在取出中写出一个的模型的标记语法\.

### 如何安装 @aparte/plugin-artifacts？

在项目目录运行 npm install @aparte/plugin-artifacts，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@aparte/core（\>=0\.32\.1 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aparte/plugin-artifacts 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aparte/plugin-artifacts 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aparte/plugin-artifacts 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aparte/plugin-artifacts 可以商用吗？

@aparte/plugin-artifacts 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @aparte/plugin-artifacts 的下载量有多少？

根据 npm 官方下载统计，@aparte/plugin-artifacts 在 2026/10/06 – 2026/11/04 这 30 天内被下载 5,115 次，日均约 171 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aparte/plugin-artifacts 还在维护吗？

最新版本 0\.32\.1 发布于 2026/11/02（4 天前）；至今共发布 46 个版本，其中过去 12 个月发布了 46 个；首次发布于 2026/08/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。