TypeScript下为Material UI Shadows加属性时的元组类型报错
Material UI Shadows 自定义类型校验报错
- 开发背景:TypeScript项目开发过程中,需要自定义Material UI的Shadows类型定义,为该类型新增自定义结构属性
- 报错信息:代码编写完成后触发类型校验,提示
Tuple type Shadows of length 25 has no element at index 25. - 排查情况:先后尝试多种公开渠道的解决方案,均未解决当前问题
- 当前现有实现:在项目根目录创建
index.d.ts文件,通过declare module语句扩展Material UI主题的Shadows类型配置 - 报错参考截图:类型校验报错场景
现有编写的类型声明代码:
declare module '@material-ui/core/styles/shadows' { type Shadows = [ { a1: string; a2: string; a3: string; } ]; }
报错成因
- 原生
@material-ui/core中Shadows类型为固定长度25的元组,索引范围0-24。上述实现直接通过模块重声明完全覆盖原有Shadows类型,将元组长度压缩为1,与主题类型校验要求的元组结构不匹配 - 单独重声明
shadows模块的导出类型,没有联动更新主题链路中对Shadows字段的类型引用,导致校验逻辑仍然沿用原生25长度的元组定义,触发结构冲突报错
正确实现方案
- 保留原生Shadows的25长度元组结构,仅将每个元组元素的类型替换为自定义结构,保证元组长度与原生校验要求一致
- 同步扩展主题核心的类型定义,而非单独重声明shadows模块的导出值,打通类型引用链路
参考实现代码:
import type { Shadows as OriginalShadows } from '@material-ui/core/styles/shadows'; // 定义自定义的单个阴影项结构 interface CustomShadowItem { a1: string; a2: string; a3: string; } // 映射生成与原生长度一致的自定义Shadows元组 type CustomShadows = { [Index in keyof OriginalShadows]: CustomShadowItem }; // 扩展主题类型的Shadows字段定义 declare module '@material-ui/core/styles/createTheme' { interface Theme { shadows: CustomShadows; } interface ThemeOptions { shadows?: CustomShadows; } }
内容的提问来源于stack exchange,提问作者user12133234
相关产品推荐
相关产品推荐

