# @haklex/rich-renderer-linkcard 中文文档

规范地址：https://npmcn.com/package/%40haklex/rich-renderer-linkcard/

版本：0\.66\.0
npm 元数据更新时间：2026-11-15T13:29:23.699Z
中文译文更新时间：2026-11-17T06:32:34.881Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40haklex/rich-renderer-linkcard
原文对照：https://npmcn.com/package/%40haklex/rich-renderer-linkcard/?lang=original
项目主页：https://github.com/Innei/haklex#readme
源码仓库：https://github.com/Innei/haklex

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

- 包体积（解压后）：158 kB，78 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>=19，lexical ^0\.53\.0，react-dom \>=19，lucide-react ^1\.0\.0，@lexical/link ^0\.53\.0，@lexical/react ^0\.53\.0，@haklex/rich-editor ^0\.66\.0，@haklex/rich-editor-ui ^0\.66\.0，@haklex/rich-style-token ^0\.66\.0
- 首次发布：2026-02-20T10:08:08.905Z
- 最新版本发布：2026-11-15T13:29:23.276Z
- 近 30 天下载量：13291（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：235（近 12 个月 235 个）

## 中文简介

带有可扩展 URL 插件的丰富链接预览卡渲染器

## 安装

```sh
npm install @haklex/rich-renderer-linkcard
```

也可以使用：`pnpm add @haklex/rich-renderer-linkcard`、`yarn add @haklex/rich-renderer-linkcard`、`bun add @haklex/rich-renderer-linkcard`

## README

# @haklex/rich-landers-linkcard (英语)

丰富的链接预览卡渲染器与元数据显示以及用于URL特有卡的可扩展插件系统.

包括GitHub repos/PRs/issues的预建插件,ArXiv论文,Bangumi条目,LetCode问题,TMDB媒体,NetEase音乐,和QQ音乐.

## 安装

```bash
pnpm add @haklex/rich-renderer-linkcard
```

## 同伴依赖关系

| 软件包 | 版本 |
| --- | --- |
| `lexical` | `^0.45.0` |
| `@lexical/react` | `^0.45.0` |
| `@lexical/link` | `^0.45.0` |
| `react` | `>=19` |
| `react-dom` | `>=19` |

## 使用量

```tsx
import { LinkCardRenderer } from '@haklex/rich-renderer-linkcard/static';

// Register in a static RendererConfig
const rendererConfig = {
  // ...other renderers
  LinkCard: LinkCardRenderer,
};
```

对于带有链接卡转换和粘贴支持的编辑模式:

```tsx
import {
  LinkCardEditNode,
  linkCardEditNodes,
  ConvertToLinkCardAction,
  PasteLinkCardPlugin,
  LinkCardFetchProvider,
} from '@haklex/rich-renderer-linkcard';

// Wrap editor with fetch provider for metadata resolution
<LinkCardFetchProvider>
  <Editor nodes={linkCardEditNodes} plugins={[<PasteLinkCardPlugin />]} />
</LinkCardFetchProvider>;
```

### 使用特定 URL 插件

```tsx
import { githubRepoPlugin, githubPrPlugin } from '@haklex/rich-renderer-linkcard';

// Plugins are auto-registered; use matchUrl to detect supported URLs
import { matchUrl } from '@haklex/rich-renderer-linkcard';
const matched = matchUrl('https://github.com/user/repo');
```

## 出口

### 构成部分

-   `LinkCardRenderer` —— 连接预览卡的静态(只读)渲染器
-   `LinkCardSkeleton` - 装入骨架占位符

### 节点和插件

-   `LinkCardEditNode` — 编辑链接卡的节点
-   `linkCardEditNodes` — 用于注册的链接卡编辑节点阵列
-   `ConvertToLinkCardAction` ——将链接转换为链接卡的动作
-   `PasteLinkCardPlugin` – 用于粘贴到卡转换的编辑插件

### A. 背景情况

-   `LinkCardFetchProvider` - 链接元数据采集提供者
-   `useLinkCardFetchContext` – 访问获取上下文的钩

### 插件登记

-   `getPluginByName` ——按名称获取插件
-   `pluginMap` ——所有已注册插件的映射
-   `plugins` — 所有已注册插件的矩阵

### 预建插件

-   `githubRepoPlugin` — GitHub 仓库卡
-   `githubPrPlugin` — GitHub PR/ 发行卡
-   ArXiv, Bangumi, LeetCode, TMDB, NetEase Music, QQ音乐插件

### URL 匹配

-   `useUrlMatcher` —— 匹配 URL 到插件的钩
-   `matchUrl` — 用于匹配已注册插件的 URL 工具

### 子路径导出

| 路径 | 说明 |
| --- | --- |
| `@haklex/rich-renderer-linkcard` | 完全导出( 编辑 + 静态 + 插件) |
| `@haklex/rich-renderer-linkcard/static` | 仅静态渲染器 |
| `@haklex/rich-renderer-linkcard/style.css` | 样式表 |

## 哈克历克的一部分

此软件包是 [哈克历](https://npmcn.com/package/README.md) 丰富的编辑生态系统.

## 许可证

麻省理工学院

## 常见问题

### @haklex/rich-renderer-linkcard 是什么？

带有可扩展 URL 插件的丰富链接预览卡渲染器

### 如何安装 @haklex/rich-renderer-linkcard？

在项目目录运行 npm install @haklex/rich-renderer-linkcard，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=19）、lexical（^0\.53\.0）、react-dom（\>=19）、lucide-react（^1\.0\.0）、@lexical/link（^0\.53\.0）、@lexical/react（^0\.53\.0）、@haklex/rich-editor（^0\.66\.0）、@haklex/rich-editor-ui（^0\.66\.0）、@haklex/rich-style-token（^0\.66\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @haklex/rich-renderer-linkcard 支持 TypeScript 吗？

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

### @haklex/rich-renderer-linkcard 支持 ESM 还是 CommonJS？

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

### @haklex/rich-renderer-linkcard 可以商用吗？

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

### @haklex/rich-renderer-linkcard 的下载量有多少？

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

### @haklex/rich-renderer-linkcard 还在维护吗？

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

