@easyx/editor 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/core/create-editor.d.ts +7 -0
- package/dist/extensions/attachment-node.d.ts +21 -0
- package/dist/extensions/audio-node.d.ts +17 -0
- package/dist/extensions/image-node-view.d.ts +20 -0
- package/dist/extensions/image-upload.d.ts +23 -0
- package/dist/extensions/indent-extension.d.ts +12 -0
- package/dist/extensions/link-open.d.ts +3 -0
- package/dist/extensions/video-node-view.d.ts +11 -0
- package/dist/extensions/video-node.d.ts +19 -0
- package/dist/index.cjs +5128 -0
- package/dist/index.d.ts +27 -0
- package/dist/index.js +5104 -0
- package/dist/shared/color-palette.d.ts +21 -0
- package/dist/shared/controls.d.ts +22 -0
- package/dist/shared/link-dropdown.d.ts +6 -0
- package/dist/shared/link-hover-popover.d.ts +8 -0
- package/dist/shared/media-dropdown.d.ts +21 -0
- package/dist/shared/tooltip.d.ts +6 -0
- package/dist/toolbar/create-bubble-menu.d.ts +7 -0
- package/dist/toolbar/create-image-menu.d.ts +7 -0
- package/dist/toolbar/create-toolbar.d.ts +9 -0
- package/dist/toolbar/create-video-menu.d.ts +7 -0
- package/dist/toolbar/toolbar-shared.d.ts +25 -0
- package/dist/types.d.ts +52 -0
- package/dist/utils/event-emitter.d.ts +9 -0
- package/dist/utils/link.d.ts +4 -0
- package/dist/utils/media-upload.d.ts +9 -0
- package/package.json +55 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
export interface PaletteColor {
|
|
2
|
+
/** 色相名称 */
|
|
3
|
+
name: string;
|
|
4
|
+
/** 色相 HSL hue 值 */
|
|
5
|
+
hue: number;
|
|
6
|
+
/** 色相 HSL saturation 值 */
|
|
7
|
+
saturation: number;
|
|
8
|
+
/** 明度级别 1-7 */
|
|
9
|
+
level: number;
|
|
10
|
+
/** 明度 HSL lightness 值 */
|
|
11
|
+
lightness: number;
|
|
12
|
+
/** 颜色值 */
|
|
13
|
+
color: string;
|
|
14
|
+
}
|
|
15
|
+
export declare const PALETTE_COLUMNS = 10;
|
|
16
|
+
export declare const PALETTE_ROWS = 7;
|
|
17
|
+
/**
|
|
18
|
+
* 70 色色板:10 色相 × 7 明度
|
|
19
|
+
* 排列按明度优先(同行同一明度,从上到下逐渐变深),10 列对应 10 种色相
|
|
20
|
+
*/
|
|
21
|
+
export declare const PALETTE_COLORS: PaletteColor[];
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { Editor } from '@tiptap/core';
|
|
2
|
+
export declare function updateBtnStates(container: HTMLElement, btnClassName: string, editor: Editor): void;
|
|
3
|
+
export declare function createDivider(className: string): HTMLDivElement;
|
|
4
|
+
export declare function addBtn(menuEl: HTMLElement, btnClassName: string, editor: Editor, icon: string, title: string, check: (e: Editor) => boolean, action: (e: Editor) => void): HTMLButtonElement;
|
|
5
|
+
/** 基于 floating-ui 的自定义下拉选择控件 */
|
|
6
|
+
export declare function createSelect(container: HTMLElement, selectClassName: string, editor: Editor, icon: string, title: string, options: readonly {
|
|
7
|
+
label: string;
|
|
8
|
+
value: string;
|
|
9
|
+
}[], getCurrent: (e: Editor) => string | null, onSelect: (e: Editor, value: string) => void, onClear: (e: Editor) => void, defaultLabel?: string, getLabel?: (value: string | null) => string): HTMLElement;
|
|
10
|
+
/** 颜色下拉模式 */
|
|
11
|
+
export type ColorDropdownMode = 'textColor' | 'highlight';
|
|
12
|
+
/** 创建带颜色网格下拉的按钮 */
|
|
13
|
+
export declare function createColorDropdown(container: HTMLElement, btnClassName: string, editor: Editor, icon: string, title: string, mode: ColorDropdownMode): HTMLButtonElement;
|
|
14
|
+
/** 创建缩进控件:图标按钮 + 数字输入框合并为一个统一 toolbar 按钮形态 */
|
|
15
|
+
export declare function createIndentControl(container: HTMLElement, indentClassName: string, btnClassName: string, inputClassName: string, editor: Editor, icon: string, title: string, inputTitle: string, checkIndent: (e: Editor) => boolean, toggleIndent: (e: Editor) => void, getIndent: (e: Editor) => number, setIndent: (e: Editor, value: number) => void): HTMLElement;
|
|
16
|
+
/**
|
|
17
|
+
* 气泡菜单文本输入框(图片 alt、视频封面等):
|
|
18
|
+
* change/Enter 提交,Escape 取消(不触发 change 提交),mousedown 不冒泡避免抢占编辑器焦点。
|
|
19
|
+
*/
|
|
20
|
+
export declare function createBubbleInput(container: HTMLElement, inputClassName: string, editor: Editor, title: string, placeholder: string, getValue: (e: Editor) => string, setValue: (e: Editor, value: string) => void): HTMLInputElement;
|
|
21
|
+
/** 创建表格插入按钮,带 grid picker 弹出层 */
|
|
22
|
+
export declare function createTableBtn(container: HTMLElement, btnClassName: string, pickerClassName: string, editor: Editor, icon: string, title: string): HTMLButtonElement;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { Editor } from '@tiptap/core';
|
|
2
|
+
/**
|
|
3
|
+
* 创建链接下拉面板按钮。
|
|
4
|
+
* 点击按钮弹出浮动面板,包含 URL 输入、应用、新窗口切换、打开链接、取消链接。
|
|
5
|
+
*/
|
|
6
|
+
export declare function createLinkDropdown(container: HTMLElement, btnClassName: string, editor: Editor, icon: string, title: string): HTMLButtonElement;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { Editor } from '@tiptap/core';
|
|
2
|
+
import type { MediaUploadConfig } from '../types';
|
|
3
|
+
/** 媒体插入载荷 */
|
|
4
|
+
export interface MediaInsertItem {
|
|
5
|
+
src: string;
|
|
6
|
+
name?: string;
|
|
7
|
+
size?: number;
|
|
8
|
+
}
|
|
9
|
+
export interface CreateMediaDropdownOptions {
|
|
10
|
+
/** 文件选择 accept 类型,如 image/*、video/* */
|
|
11
|
+
accept: string;
|
|
12
|
+
/** 插入回调,由调用方决定调用 setImage/setVideo 等命令 */
|
|
13
|
+
insert: (item: MediaInsertItem) => void;
|
|
14
|
+
/** 按钮选中态判断,默认恒为 false */
|
|
15
|
+
isActive?: (e: Editor) => boolean;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* 通用媒体插入下拉:上传 / 网络地址 / 媒体库 通过 Tab 切换。
|
|
19
|
+
* 媒体库仅在配置了 getList 时显示,支持搜索与分页。
|
|
20
|
+
*/
|
|
21
|
+
export declare function createMediaDropdown(container: HTMLElement, btnClassName: string, icon: string, title: string, config: MediaUploadConfig, opts: CreateMediaDropdownOptions): HTMLButtonElement;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Editor } from '@tiptap/core';
|
|
2
|
+
export declare function createImageMenuElement(): HTMLElement;
|
|
3
|
+
/**
|
|
4
|
+
* 图片选中浮层(第二个 BubbleMenu 实例):对齐 / 宽度 / 替代文本 / 删除 / 查看原图。
|
|
5
|
+
* 仅在选中 imageUpload 节点时显示,由 create-editor 注册。
|
|
6
|
+
*/
|
|
7
|
+
export declare function populateImageMenu(menuEl: HTMLElement, editor: Editor): () => void;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { Editor } from '@tiptap/core';
|
|
2
|
+
import type { MediaUploadConfig } from '../types';
|
|
3
|
+
export declare function createToolbarElement(): HTMLElement;
|
|
4
|
+
export declare function populateToolbar(toolbarEl: HTMLElement, editor: Editor, mediaConfig?: {
|
|
5
|
+
image?: MediaUploadConfig;
|
|
6
|
+
video?: MediaUploadConfig;
|
|
7
|
+
audio?: MediaUploadConfig;
|
|
8
|
+
attachment?: MediaUploadConfig;
|
|
9
|
+
}): () => void;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Editor } from '@tiptap/core';
|
|
2
|
+
export declare function createVideoMenuElement(): HTMLElement;
|
|
3
|
+
/**
|
|
4
|
+
* 视频选中浮层(第三个 BubbleMenu 实例):对齐 / 封面 / 控制器 / 自动播放 / 删除。
|
|
5
|
+
* 仅在选中 videoNode 节点时显示,由 create-editor 注册。
|
|
6
|
+
*/
|
|
7
|
+
export declare function populateVideoMenu(menuEl: HTMLElement, editor: Editor): () => void;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { Editor } from '@tiptap/core';
|
|
2
|
+
/**
|
|
3
|
+
* 工具栏/气泡菜单图标常量,统一选用 Remix Icon(Apache-2.0)。
|
|
4
|
+
* 官方仓库:https://github.com/remixicon/remixicon,path 数据取自其中图标,颜色继承 currentColor。
|
|
5
|
+
*/
|
|
6
|
+
export declare const ICONS: Record<string, string>;
|
|
7
|
+
/** 字体大小预设 */
|
|
8
|
+
export declare const FONT_SIZE_OPTIONS: {
|
|
9
|
+
label: string;
|
|
10
|
+
value: string;
|
|
11
|
+
}[];
|
|
12
|
+
/** 行高预设 */
|
|
13
|
+
export declare const LINE_HEIGHT_OPTIONS: {
|
|
14
|
+
label: string;
|
|
15
|
+
value: string;
|
|
16
|
+
}[];
|
|
17
|
+
/** 标题级别预设 */
|
|
18
|
+
export declare const HEADING_OPTIONS: {
|
|
19
|
+
label: string;
|
|
20
|
+
value: string;
|
|
21
|
+
}[];
|
|
22
|
+
/** 批量更新容器内所有 select 的选中值 */
|
|
23
|
+
export declare function updateSelectStates(container: HTMLElement, selectClassName: string, _editor: Editor): void;
|
|
24
|
+
/** 批量更新容器内所有输入框的显示值(缩进、气泡菜单 alt/封面等) */
|
|
25
|
+
export declare function updateInputs(container: HTMLElement, inputClassName: string, _editor: Editor): void;
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
export type ContentType = string;
|
|
2
|
+
export type ThemeType = 'light' | 'dark';
|
|
3
|
+
/** 图片配置:在通用媒体配置基础上增加图片专属选项 */
|
|
4
|
+
export type ImageMediaUploadConfig = MediaUploadConfig & {
|
|
5
|
+
/** 是否开启图片拖拽缩放,默认 true */
|
|
6
|
+
resizable?: boolean;
|
|
7
|
+
};
|
|
8
|
+
/** 编辑器初始化配置 */
|
|
9
|
+
export interface EasyxEditorOptions {
|
|
10
|
+
placeholder?: string;
|
|
11
|
+
readOnly?: boolean;
|
|
12
|
+
autoFocus?: boolean;
|
|
13
|
+
defaultContent?: ContentType;
|
|
14
|
+
defaultTheme?: ThemeType;
|
|
15
|
+
image?: ImageMediaUploadConfig;
|
|
16
|
+
video?: MediaUploadConfig;
|
|
17
|
+
audio?: MediaUploadConfig;
|
|
18
|
+
attachment?: MediaUploadConfig;
|
|
19
|
+
onChange?: (content: ContentType) => void;
|
|
20
|
+
onReady?: () => void;
|
|
21
|
+
onFocus?: () => void;
|
|
22
|
+
onBlur?: () => void;
|
|
23
|
+
onDestroy?: () => void;
|
|
24
|
+
}
|
|
25
|
+
/** 媒体列表项 */
|
|
26
|
+
export interface MediaItem {
|
|
27
|
+
id: string;
|
|
28
|
+
url: string;
|
|
29
|
+
name: string;
|
|
30
|
+
size?: number;
|
|
31
|
+
thumbnailUrl?: string;
|
|
32
|
+
duration?: number;
|
|
33
|
+
fileType?: string;
|
|
34
|
+
}
|
|
35
|
+
/** 媒体列表分页参数 */
|
|
36
|
+
export interface MediaListParams {
|
|
37
|
+
page: number;
|
|
38
|
+
pageSize: number;
|
|
39
|
+
keyword?: string;
|
|
40
|
+
}
|
|
41
|
+
/** 媒体列表分页结果 */
|
|
42
|
+
export interface MediaListResult {
|
|
43
|
+
items: MediaItem[];
|
|
44
|
+
total: number;
|
|
45
|
+
}
|
|
46
|
+
/** 上传进度回调 */
|
|
47
|
+
export type UploadProgressCallback = (progress: number) => void;
|
|
48
|
+
/** 单个媒体类型的上传 + 列表配置 */
|
|
49
|
+
export interface MediaUploadConfig {
|
|
50
|
+
upload: (file: File, onProgress?: UploadProgressCallback) => Promise<MediaItem>;
|
|
51
|
+
getList?: (params: MediaListParams) => Promise<MediaListResult>;
|
|
52
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export type EventHandler = (...args: unknown[]) => void;
|
|
2
|
+
export declare class EventEmitter {
|
|
3
|
+
private handlers;
|
|
4
|
+
on(event: string, handler: EventHandler): void;
|
|
5
|
+
off(event: string, handler: EventHandler): void;
|
|
6
|
+
once(event: string, handler: EventHandler): void;
|
|
7
|
+
emit(event: string, ...args: unknown[]): void;
|
|
8
|
+
removeAllListeners(): void;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { Editor } from '@tiptap/core';
|
|
2
|
+
import type { EasyxEditorOptions } from '../types';
|
|
3
|
+
/**
|
|
4
|
+
* 按文件类型路由到对应媒体的 upload 并插入。
|
|
5
|
+
* 用于编辑器内容区粘贴 / 拖入上传;返回 true 表示已接管该文件。
|
|
6
|
+
* @param pos 插入位置,缺省使用当前选区
|
|
7
|
+
* @param onError 上传失败回调(默认静默)
|
|
8
|
+
*/
|
|
9
|
+
export declare function routeMediaUpload(file: File, editor: Editor, options: EasyxEditorOptions, pos?: number, onError?: (file: File, error: unknown) => void): boolean;
|
package/package.json
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@easyx/editor",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"exports": {
|
|
6
|
+
".": {
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"import": "./dist/index.js",
|
|
9
|
+
"require": "./dist/index.cjs"
|
|
10
|
+
},
|
|
11
|
+
"./*": {
|
|
12
|
+
"types": "./dist/*.d.ts",
|
|
13
|
+
"import": "./dist/*.js",
|
|
14
|
+
"require": "./dist/*.cjs"
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"types": "./dist/index.d.ts",
|
|
18
|
+
"files": [
|
|
19
|
+
"dist"
|
|
20
|
+
],
|
|
21
|
+
"publishConfig": {
|
|
22
|
+
"access": "public"
|
|
23
|
+
},
|
|
24
|
+
"dependencies": {
|
|
25
|
+
"@floating-ui/dom": "^1.7.6",
|
|
26
|
+
"@tiptap/core": "^3.27.1",
|
|
27
|
+
"@tiptap/extension-bubble-menu": "^3.27.1",
|
|
28
|
+
"@tiptap/extension-image": "^3.27.1",
|
|
29
|
+
"@tiptap/extension-list": "^3.27.1",
|
|
30
|
+
"@tiptap/extension-subscript": "^3.27.1",
|
|
31
|
+
"@tiptap/extension-superscript": "^3.27.1",
|
|
32
|
+
"@tiptap/extension-table": "^3.27.1",
|
|
33
|
+
"@tiptap/extension-text-align": "^3.27.1",
|
|
34
|
+
"@tiptap/extension-text-style": "^3.27.1",
|
|
35
|
+
"@tiptap/extension-typography": "^3.27.1",
|
|
36
|
+
"@tiptap/extensions": "^3.27.1",
|
|
37
|
+
"@tiptap/pm": "^3.27.1",
|
|
38
|
+
"@tiptap/starter-kit": "^3.27.1",
|
|
39
|
+
"@easyx/tiptap-table-plus": "1.0.0"
|
|
40
|
+
},
|
|
41
|
+
"devDependencies": {
|
|
42
|
+
"@rsbuild/plugin-sass": "^2.0.1",
|
|
43
|
+
"@rslib/core": "^0.23.0",
|
|
44
|
+
"@rstest/adapter-rslib": "^0.10.5",
|
|
45
|
+
"@rstest/core": "^0.10.5",
|
|
46
|
+
"happy-dom": "^20.10.3",
|
|
47
|
+
"typescript": "^6.0.3"
|
|
48
|
+
},
|
|
49
|
+
"scripts": {
|
|
50
|
+
"dev": "rslib --watch",
|
|
51
|
+
"build": "rslib build",
|
|
52
|
+
"test": "rstest",
|
|
53
|
+
"test:watch": "rstest --watch"
|
|
54
|
+
}
|
|
55
|
+
}
|