@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-- 匹配所有支持的嵌入类型 URLisTweetUrl, (中文(简体) ),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 | 样式表 |
哈克历克的一部分
此软件包是 哈克历 丰富的编辑生态系统.
许可证
麻省理工学院