在element-tiptap中实现自定义表格组件

在element-tiptap中实现自定义表格组件

【免费下载链接】element-tiptap 🌸A modern WYSIWYG rich-text editor using tiptap and Element UI for Vue3 (1.0 for Vue2) 项目地址: https://gitcode.com/gh_mirrors/el/element-tiptap

element-tiptap是一个基于Vue.js和Prosemirror的富文本编辑器组件。本文将详细介绍如何在element-tiptap中实现自定义表格组件，并通过菜单栏点击添加该组件。

自定义表格组件实现原理

在element-tiptap中，自定义节点需要通过Node.create()方法来创建。一个完整的自定义节点需要定义以下几个关键部分：

1. 节点基本信息：包括节点名称(name)和所属组别(group)
2. HTML解析与渲染：定义如何从HTML解析节点以及如何将节点渲染为HTML
3. 节点属性：定义节点可以包含哪些属性
4. 节点视图：定义节点在前端如何显示
5. 命令：定义如何通过命令插入该节点

具体实现代码分析

以下是实现自定义表格组件的完整代码示例：

export const test = Node.create({
  name: 'TableCellComponent',  // 节点名称
  group: 'block',  // 节点分组
  
  // 定义如何从HTML解析该节点
  parseHTML() {
    return [{ tag: 'TableCellComponent' }];
  },
  
  // 定义如何将节点渲染为HTML
  renderHTML({ HTMLAttributes }) {
    return ['TableCellComponent', HTMLAttributes, 0];
  },
  
  // 定义节点属性
  addAttributes() {
    return {
      count: {
        default: 0,
      },
      list: {
        default: {
          reqH: [
            {
              id: +new Date(),
              require: false,
              length: '1',
              default: '1223',
              reqType: '',
              name: '1',
              textarea: ''
            }
          ],
        }
      },
    }
  },
  
  // 定义节点视图
  addNodeView() {
    return VueNodeViewRenderer(TableCellComponent);
  },
  
  // 定义插入节点的命令
  addCommands() {
    return {
      insetTest: () => ({ tr, dispatch, editor, commands }) => {
        const roles: { [key: string]: NodeType } =  editor.schema.cached.TableCellComponent || {}
        
        if(!roles.TableCellComponent){
          // 在schema中查找对应的节点类型
          Object.keys(editor.schema.nodes).forEach(type => {
            const nodeType = editor.schema.nodes[type]
            if (nodeType.name == 'TableCellComponent') {
              roles[nodeType.name] = nodeType
            }
          })
          editor.schema.cached.TableCellComponent = roles
        }
        
        const rows: ProsemirrorNode[] = []
        const node = roles.TableCellComponent.createChecked(null, rows)
        if (dispatch) {
          const offset = tr.selection.anchor
          tr.replaceSelectionWith(node)  
            .scrollIntoView()
            .setSelection(TextSelection.near(tr.doc.resolve(offset)))
        }
        return true
      }
    }
  }
});

关键点解析

1. 节点名称与分组：

   • name属性定义了节点的唯一标识
   • group属性定义了节点所属的组别，这里设置为'block'表示这是一个块级元素

2. HTML解析与渲染：

   • parseHTML方法定义了如何从HTML中识别该节点
   • renderHTML方法定义了如何将该节点渲染为HTML

3. 节点属性：

   • addAttributes方法定义了节点可以包含的属性及其默认值
   • 示例中定义了count和list两个属性，其中list属性包含了一个复杂的默认结构

4. 节点视图：

   • addNodeView方法使用VueNodeViewRenderer来渲染自定义的Vue组件
   • 这里的TableCellComponent是一个自定义的Vue组件

5. 插入命令：

   • addCommands方法定义了如何通过命令插入该节点
   • 命令内部处理了节点的创建、插入位置选择等逻辑

实际应用建议

1. 组件设计：

   • 在设计自定义表格组件时，应该考虑表格的各种状态和交互
   • 可以为表格设计添加行、删除行、调整列宽等功能

2. 属性设计：

   • 根据实际需求设计合适的节点属性
   • 复杂的表格可能需要定义行列数、单元格内容等属性

3. 性能优化：

   • 对于大型表格，考虑实现虚拟滚动等优化手段
   • 可以按需加载表格数据

4. 样式处理：

   • 为表格组件设计独立的样式
   • 考虑响应式设计，使表格在不同设备上都能良好显示

通过以上方法，开发者可以在element-tiptap中实现功能丰富的自定义表格组件，满足各种复杂的编辑需求。

【免费下载链接】element-tiptap 🌸A modern WYSIWYG rich-text editor using tiptap and Element UI for Vue3 (1.0 for Vue2) 项目地址: https://gitcode.com/gh_mirrors/el/element-tiptap