# @edv4h/usketch-plugin-deep-link 中文文档

规范地址：https://npmcn.com/package/%40edv4h/usketch-plugin-deep-link/

版本：0\.2\.18
npm 元数据更新时间：2026-11-10T02:55:15.912Z
中文译文更新时间：2026-11-13T07:45:35.332Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40edv4h/usketch-plugin-deep-link
原文对照：https://npmcn.com/package/%40edv4h/usketch-plugin-deep-link/?lang=original
项目主页：https://github.com/EdV4H/usketch#readme
源码仓库：https://github.com/EdV4H/usketch

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

- 包体积（解压后）：29.4 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2026-08-05T13:31:17.628Z
- 最新版本发布：2026-11-10T02:55:15.551Z
- 近 30 天下载量：2420（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @edv4h/usketch-plugin-deep-link
```

也可以使用：`pnpm add @edv4h/usketch-plugin-deep-link`、`yarn add @edv4h/usketch-plugin-deep-link`、`bun add @edv4h/usketch-plugin-deep-link`

## README

# @edv4h/usketch-plugin-deep-link (英语)

形状 **URL( URL) QQ( URL)**缩略语 `?node-id=...`(選択ノードへのリンク)に相当する体験を提供する。。

## URL( URL) QQ( URL)

```
?shape=<id>[,<id>...]   選択（複数対応・ライブ同期）
?x=<n>&y=<n>&zoom=<n>   厳密なカメラ位置（「この表示へのリンク」用）
```

-   **選択はライブ同期**: 形状qq `history.replaceState` で `?shape=` が更新される(履歴は汚さない)。
-   **カメラは明示スナップショット**翻译:`encodeDeepLink` で 現在の `viewport` \[永久失效連結\] \[永久失效連結\]。
-   URL 形状 形状 CRDT 形状 届いていない場合は `shape:added` を購読して出現までリトライする(タイムアウトあり)。カメラ 指定があれば自動フレーミングより優先して厳密復元する。

## 使い方

```ts
import { createDeepLinkPlugin } from "@edv4h/usketch-plugin-deep-link";

// createApp は非同期。
const app = await createApp({ store, plugins: [createDeepLinkPlugin()] });
```

「この表示へのリンク」を作る側(共有ダイアログ等) `encodeDeepLink` を利用する:

```ts
import { encodeDeepLink } from "@edv4h/usketch-plugin-deep-link";

const search = encodeDeepLink(window.location.search, {
    shapeIds: [...store.getSelection()],
    camera: store.getViewport(),
});
const url = `${window.location.origin}${window.location.pathname}${search}`;
```

## エクスポート

-   `createDeepLinkPlugin()` . . . . . 。
-   `encodeDeepLink(search, state)` 编号 : `decodeDeepLink(search)` —— URL ⇄。
-   `applyDeepLink(store, search, onDone?)` - 。
-   `frameShapes(store, ids, opts?)` - \* \* \* \* \* \* 形状 \* \* \* \* \* \* \* 。

## 常见问题

### 如何安装 @edv4h/usketch-plugin-deep-link？

在项目目录运行 npm install @edv4h/usketch-plugin-deep-link，或使用 pnpm add / yarn add / bun add。

### @edv4h/usketch-plugin-deep-link 支持 TypeScript 吗？

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

### @edv4h/usketch-plugin-deep-link 支持 ESM 还是 CommonJS？

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

### @edv4h/usketch-plugin-deep-link 可以商用吗？

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

### @edv4h/usketch-plugin-deep-link 的下载量有多少？

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

### @edv4h/usketch-plugin-deep-link 还在维护吗？

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