首页
/ Chakra UI与Framer Motion组件封装中的类型兼容性问题解析

Chakra UI与Framer Motion组件封装中的类型兼容性问题解析

2025-05-03 09:03:23作者:何举烈Damon

问题背景

在使用Chakra UI与Framer Motion结合开发时,开发者经常会遇到将Chakra组件封装为Motion组件的需求。然而,在最新版本的Chakra UI(2.8.2)中,直接使用motion(Flex)这样的方式会导致TypeScript类型错误,这与之前版本的行为有所不同。

错误现象

当尝试将Chakra UI的Flex组件通过Framer Motion的motion函数进行封装时,TypeScript会抛出以下错误:

Argument of type 'ComponentWithAs<"div", FlexProps>' is not assignable to parameter of type 'string | ForwardRefExoticComponent<MergeWithAs<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, any, FlexProps, As>>'.
Property '$$typeof' is missing in type 'ComponentWithAs<"div", FlexProps>' but required in type 'ForwardRefExoticComponent<MergeWithAs<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, any, FlexProps, As>>'.

问题根源

这个问题的本质在于Chakra UI组件和Framer Motion期望的组件类型不匹配。Chakra UI的组件使用了ComponentWithAs类型,而Framer Motion的motion函数期望接收一个ForwardRefExoticComponent类型的组件。

解决方案

类型断言解决方案

通过类型断言可以明确告诉TypeScript组件的实际类型,使其符合Framer Motion的期望:

import { 
  As, 
  Flex, 
  FlexProps,
  Image,
  ImageProps,
  Box,
  ChakraProps,
  Text,
  TextProps,
  MergeWithAs 
} from "@chakra-ui/react";
import { motion } from "framer-motion";
import { 
  DetailedHTMLProps, 
  ForwardRefExoticComponent, 
  HTMLAttributes, 
  ImgHTMLAttributes 
} from "react";

export const MotionFlex = motion(
  Flex as ForwardRefExoticComponent<
    MergeWithAs<
      DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 
      any, 
      FlexProps, 
      As
    >
  >
);

export const MotionImage = motion(
  Image as ForwardRefExoticComponent<
    MergeWithAs<
      DetailedHTMLProps<ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, 
      any, 
      ImageProps, 
      As
    >
  >
);

export const MotionBox = motion(
  Box as ForwardRefExoticComponent<
    MergeWithAs<
      DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 
      any, 
      Omit<ChakraProps, never>, 
      As
    >
  >
);

export const MotionText = motion(
  Text as ForwardRefExoticComponent<
    MergeWithAs<
      DetailedHTMLProps<HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, 
      any, 
      TextProps, 
      As
    >
  >
);

方案解析

  1. 类型断言:使用as关键字将Chakra组件断言为Framer Motion期望的类型
  2. 类型结构:每个组件的类型都包含:
    • 基础的HTML属性类型
    • Chakra特定的props类型
    • 组件可能被渲染为的As类型
  3. 通用模式:对于不同的Chakra组件,只需要替换对应的props类型即可

最佳实践建议

  1. 集中管理Motion组件:建议将所有Motion封装组件集中在一个文件中导出,便于维护
  2. 按需封装:不需要为所有Chakra组件都创建Motion版本,只封装实际需要动画效果的组件
  3. 类型安全:虽然使用了类型断言,但这种模式是类型安全的,因为它准确地描述了组件的实际结构
  4. 版本兼容性:注意Chakra UI和Framer Motion版本升级可能带来的类型变化

总结

Chakra UI和Framer Motion都是优秀的UI库,但在结合使用时可能会遇到类型兼容性问题。通过合理的类型断言可以解决这些问题,同时保持代码的类型安全性。这种解决方案不仅适用于Flex组件,也可以推广到Chakra UI的其他基础组件上。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8