@haklex/rich-ext-embed

中文文档
0.66.0发布于 2026/11/15MITTypeScriptES Module构建来源已验证近 30 天下载 1.3万

嵌入了Twitter,YouTube等的扩展.

中文使用文档
文档目录20 节
  1. 安装
  2. 同伴依赖关系
  3. 使用量
  4. 在编辑器配置中注册节点
  5. 使用嵌入插件
  6. 在程序上插入嵌入
  7. 使用渲染器
  8. 提供自定义嵌入式渲染器
  9. 匹配公用事业的 URL
  10. 导入样式
  11. 出口
  12. 节点
  13. 渲染器
  14. 插件
  15. A. 背景情况
  16. URL 匹配点
  17. 类型
  18. 子路径导出
  19. 哈克历克的一部分
  20. 许可证

@haklex/rich-ext-embed (英语)

URL嵌入了支持Twitter,YouTube,苹果音乐,Spotify,bilibili,CodeSandbox,和GitHub Gist的扩展.

安装

pnpm add @haklex/rich-ext-embed

同伴依赖关系

软件包版本需求
@lexical/react^0.45.0对
lexical^0.45.0对
react>= 19对
react-dom>= 19对
shiki>= 3可选

使用量

在编辑器配置中注册节点

import { embedEditNodes } from '@haklex/rich-ext-embed';

const editorConfig = {
  nodes: [...embedEditNodes],
};

用于静态/只读渲染 :

import { embedNodes } from '@haklex/rich-ext-embed/static';

const staticConfig = {
  nodes: [...embedNodes],
};

使用嵌入插件

import { EmbedPlugin } from '@haklex/rich-ext-embed';

function EditorPlugins() {
  return <EmbedPlugin />;
}

在程序上插入嵌入

import { INSERT_EMBED_COMMAND } from '@haklex/rich-ext-embed';

editor.dispatchCommand(INSERT_EMBED_COMMAND, { url: 'https://youtube.com/watch?v=...' });

使用渲染器

import { EmbedLinkRenderer } from '@haklex/rich-ext-embed';
import { EmbedStaticRenderer } from '@haklex/rich-ext-embed/static';

提供自定义嵌入式渲染器

import { EmbedRendererProvider, useEmbedRenderers } from '@haklex/rich-ext-embed';

function App() {
  return (
    <EmbedRendererProvider>
      <Editor />
    </EmbedRendererProvider>
  );
}

匹配公用事业的 URL

import {
  matchEmbedUrl,
  isTweetUrl,
  isYoutubeUrl,
  isAppleMusicUrl,
  isSpotifyUrl,
  isBilibiliVideoUrl,
  isCodesandboxUrl,
  isGistUrl,
  isGithubFilePreviewUrl,
  createSelfThinkingMatcher,
} from '@haklex/rich-ext-embed';

导入样式

import '@haklex/rich-ext-embed/style.css';

出口

节点

  • EmbedNode -- 静态( 只读) 节点
  • EmbedEditNode -- 使用交互式 UI 编辑节点
  • $createEmbedNode() 编号 : $isEmbedNode() - 语言辅助人员
  • embedNodes -- 用于配置注册的静态节点阵列
  • embedEditNodes -- 用于配置注册的编辑节点数组

渲染器

  • EmbedStaticRenderer -- 静态渲染器
  • EmbedLinkRenderer -- 链接式嵌入式渲染器

插件

  • EmbedPlugin -- 嵌入式插入的编辑器插件
  • INSERT_EMBED_COMMAND -- 程序插入的语法命令

A. 背景情况

  • EmbedRendererProvider -- 自定义嵌入式渲染器的上下文提供者
  • useEmbedRenderers -- 访问嵌入式渲染器上下文的钩子

URL 匹配点

  • matchEmbedUrl -- 匹配所有支持的嵌入类型 URL
  • isTweetUrl, (中文(简体) ), isYoutubeUrl, (中文(简体) ), isAppleMusicUrl, (中文(简体) ), isSpotifyUrl, (中文(简体) ), isBilibiliVideoUrl, (中文(简体) ), isCodesandboxUrl, (中文(简体) ), isGistUrl, (中文(简体) ), isGithubFilePreviewUrl -- 个人 URL 匹配器
  • createSelfThinkingMatcher -- 自定义 URL 匹配器的工厂

类型

  • EmbedType -- 所支持的嵌入型号

子路径导出

路径说明
@haklex/rich-ext-embed全部出口(编辑+静态)
@haklex/rich-ext-embed/static仅静态( 无重UI 道口)
@haklex/rich-ext-embed/style.css样式表

哈克历克的一部分

此软件包是 哈克历 丰富的编辑生态系统.

许可证

麻省理工学院

版本与发布记录

@haklex/rich-ext-embed 共发布 238 个版本,首次发布于 2026/02/20;过去 12 个月发布了 238 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.66.0latest2026/11/151 天前
0.65.72026/11/143 天前
0.65.62026/11/124 天前
0.65.52026/11/124 天前
0.65.42026/11/124 天前
0.65.32026/11/124 天前

关于 @haklex/rich-ext-embed 的常见问题

@haklex/rich-ext-embed 是什么?

嵌入了Twitter,YouTube等的扩展.

如何安装 @haklex/rich-ext-embed?

在项目目录运行 npm install @haklex/rich-ext-embed,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=19)、lexical(^0.53.0)、react-dom(>=19)、lucide-react(^1.0.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-ext-embed 支持 TypeScript 吗?

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

@haklex/rich-ext-embed 支持 ESM 还是 CommonJS?

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

@haklex/rich-ext-embed 可以商用吗?

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

@haklex/rich-ext-embed 的下载量有多少?

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

@haklex/rich-ext-embed 还在维护吗?

最新版本 0.66.0 发布于 2026/11/15(1 天前);至今共发布 238 个版本,其中过去 12 个月发布了 238 个;首次发布于 2026/02/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。