Yoopta-Editor 自定义卡片组件开发指南

概述

Yoopta-Editor 是一个功能强大的富文本编辑器框架，它允许开发者通过插件机制创建自定义的内容块。本文将详细介绍如何在 Yoopta-Editor 中开发一个复杂的卡片组件，包含日期选择器、文本输入和图片轮播等交互元素。

组件结构设计

一个完整的卡片组件通常需要包含以下元素：

1. 卡片容器：作为整个组件的根元素
2. 卡片头部：包含标题和描述
3. 卡片内容区域：主要展示内容
4. 卡片底部：放置操作按钮或额外信息
5. 日期选择器：允许用户选择日期
6. 图片轮播：展示多张图片

实现方案

1. 定义元素类型

首先需要为每个组件部分定义 Slate 元素类型：

type MarkerBlockType = SlateElement<'marker-block'>;
type MarkerCardContentType = SlateElement<'marker-content'>;
type MarkerBodyType = SlateElement<'marker-body', { imgSrcs: string[] }>;
type MarkerHeaderType = SlateElement<'marker-header'>;
type MarkerDateType = SlateElement<'marker-date', { timestamp: number }>;
type MarkerDescriptionType = SlateElement<'marker-description'>;
type MarkerTitleType = SlateElement<'marker-title'>;

2. 创建插件结构

使用 YooptaPlugin 创建插件实例，定义各个元素的渲染方式和层级关系：

const MarkerBlockPlugin = new YooptaPlugin({
  type: 'Block',
  elements: {
    'marker-block': {
      render: MarkerBlock,
      children: ['marker-header', 'marker-content'],
      asRoot: true,
      props: {
        timestamp: Date.now(),
      },
    },
    'marker-content': {
      render: MarkerCardContent,
      children: ['marker-body']
    },
    'marker-header': {
      render: MarkerHeader,
      children: ['marker-date', 'marker-title', 'marker-description'],
    },
    'marker-date': {
      render: MarkerDate,
      props: {
        timestamp: Date.now(),
      },
    },
    // 其他元素定义...
  },
});

3. 实现渲染组件

为每个元素创建对应的 React 组件：

const MarkerBlock = ({ attributes, children }: PluginElementRenderProps) => {
  return <Card {...attributes}>{children}</Card>;
};

const MarkerDate = ({ element }: PluginElementRenderProps) => {
  const [date, setDate] = useState<Date | undefined>(
    new Date(element.props.timestamp) ?? undefined
  );
  return <DateTimePicker date={date} setDate={setDate} />;
};

const MarkerBody = ({ element }: PluginElementRenderProps) => {
  const imgSrc = element.props.imgSrcs || [];
  
  return (
    <div>
      {imgSrc.length > 0 && (
        <Carousel plugins={[Autoplay({ delay: 3000 })]}>
          <CarouselContent>
            {imgSrc.map((src, index) => (
              <CarouselItem key={index}>
                <Card>
                  <CardContent>
                    <Image src={src} alt={`图片 ${index}`} />
                  </CardContent>
                </Card>
              </CarouselItem>
            ))}
          </CarouselContent>
          <CarouselPrevious />
          <CarouselNext />
        </Carousel>
      )}
    </div>
  );
};

关键实现细节

1. 状态管理：对于日期选择器等需要状态的组件，使用 React 的 useState 管理状态

2. 图片上传处理：可以通过 props 传递图片 URL 数组，在渲染时动态生成轮播项

3. 内容可编辑性：对于需要用户输入的文本区域，确保 contentEditable 属性正确设置

4. 数据持久化：所有用户输入的数据都会自动保存在编辑器的数据结构中

最佳实践建议

1. 组件拆分：将复杂的组件拆分为多个子组件，提高代码可维护性

2. 类型安全：充分利用 TypeScript 的类型系统，为每个元素定义明确的 props 类型

3. 响应式设计：确保组件在不同屏幕尺寸下都能正常显示

4. 性能优化：对于图片轮播等资源密集型组件，考虑实现懒加载

总结

通过 Yoopta-Editor 的插件系统，开发者可以创建高度定制化的内容块组件。本文展示的卡片组件实现方案涵盖了从结构设计到具体实现的完整流程，开发者可以根据实际需求进行调整和扩展。Yoopta-Editor 的灵活架构使得构建复杂的富文本编辑体验变得简单高效。