# @algorisys/yappydraw 中文文档

规范地址：https://npmcn.com/package/%40algorisys/yappydraw/

版本：0\.8\.306
npm 元数据更新时间：2026-11-05T11:49:01.783Z
中文译文更新时间：2026-11-06T07:26:41.589Z
软件包许可：AGPL-3\.0-only

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

原始 npm 页面：https://www.npmjs.com/package/%40algorisys/yappydraw
原文对照：https://npmcn.com/package/%40algorisys/yappydraw/?lang=original
项目主页：https://yappydraw.com/
源码仓库：https://github.com/algorisys-oss/yappydraw

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

- 包体积（解压后）：11.6 MB，63 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-09-14T08:47:08.410Z
- 最新版本发布：2026-11-05T11:49:01.568Z
- 近 30 天下载量：4185（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 34 个）

## 中文简介

YappyDraw在没有编辑器的情况下绘制API:手绘和干净的形状,在浏览器中被渲染为SVG.

## 安装

```sh
npm install @algorisys/yappydraw
```

也可以使用：`pnpm add @algorisys/yappydraw`、`yarn add @algorisys/yappydraw`、`bun add @algorisys/yappydraw`

## README

# @algorisys/ yappidraw (英语)

这个 [雅皮画](https://yappydraw.com/) 绘制没有编辑器的 API,作为浏览器 ES 模块. 以代码创建形状,然后将它们变成内置的SVG. 每一个形状都是 `<g data-yappy-id="…">`, (中文(简体) ), 所以CSS和动画库可以瞄准它.

```sh
npm install @algorisys/yappydraw
```

```js
import { Yappy, mount, fontsReady } from '@algorisys/yappydraw'

await fontsReady()   // before creating any text
const sun = Yappy.createCircle(40, 40, 120, 120, { backgroundColor: '#ffd166', fillStyle: 'hachure' })
mount('#stage')      // inline SVG
```

或者没有安装,从CDN:

```html
<script type="module">
  import { Yappy, mount } from 'https://cdn.jsdelivr.net/npm/@algorisys/yappydraw@0.8.306/yappy.js'
</script>
```

| 导出 | 什麽 |
| --- | --- |
| `Yappy` | 全数 `window.Yappy` API : (英语) `create*`, (中文(简体) ), `importDSL`, (中文(简体) ), `loadDocument`,... (参见应用帮助) |
| `toSVG(options?)` | SVG 标记,默认情况下元素的ID. 从不下载文件. |
| `mount(target, options?)` | 以内置 SVG 为元素; 返回 `<svg>` |
| `fontsReady()` | 装入 YappyDraw 字体; 在创建文本前等待 |
| `clear()` | 开始新画 |
| `version` | YappyDraw 版本 此版本从 |

## 页:1

-   **仅浏览器 .** 它需要一个DOM和画布来进行文字测量.
-   **每页画一幅.** 该商店是一个模块单通;呼叫 `clear()` 在建造下一个之前.
-   **保留 `chunks/` 旁边 `yappy.js`。 。 。 .** MathJax和出口商从那里装入第一个 使用时间.
-   **许可证: AGPL-3.0**作为YappyDraw的其余部分. 检查它是否适合您的项目之前 将其捆绑入您作为网络服务分发或运行的软件.

资料来源: [agorisys-oss/yappidraw @ v0.8.306 (英语)](https://github.com/algorisys-oss/yappydraw/tree/v0.8.306)。 。 。 .

## 常见问题

### @algorisys/yappydraw 是什么？

YappyDraw在没有编辑器的情况下绘制API:手绘和干净的形状,在浏览器中被渲染为SVG\.

### 如何安装 @algorisys/yappydraw？

在项目目录运行 npm install @algorisys/yappydraw，或使用 pnpm add / yarn add / bun add。

### @algorisys/yappydraw 支持 TypeScript 吗？

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

### @algorisys/yappydraw 支持 ESM 还是 CommonJS？

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

### @algorisys/yappydraw 可以商用吗？

@algorisys/yappydraw 使用 AGPL-3\.0-only 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @algorisys/yappydraw 的下载量有多少？

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

### @algorisys/yappydraw 还在维护吗？

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